@hashgraph/solo
    Preparing search index...

    Interface KindClient

    The KindClient is a bridge between TypeScript and the Kind CLI.

    interface KindClient {
        buildNodeImage(
            options?: BuildNodeImagesOptions,
        ): Promise<BuildNodeImagesResponse>;
        createCluster(
            clusterName?: string,
            options?: ClusterCreateOptions,
        ): Promise<ClusterCreateResponse>;
        deleteCluster(
            clusterName?: string,
            options?: ClusterDeleteOptions,
        ): Promise<ClusterDeleteResponse>;
        exportKubeConfig(clusterName?: string): Promise<ExportKubeConfigResponse>;
        exportLogs(clusterName?: string): Promise<ExportLogsResponse>;
        getClusters(): Promise<KindCluster[]>;
        getKubeConfig(
            contextName?: string,
            options?: GetKubeConfigOptions,
        ): Promise<GetKubeConfigResponse>;
        getNodes(
            contextName?: string,
            options?: GetNodesOptions,
        ): Promise<GetNodesResponse>;
        loadDockerImage(
            imageName: string,
            options?: LoadDockerImageOptions,
        ): Promise<LoadDockerImageResponse>;
        loadImageArchive(
            imageName: string,
            options?: LoadImageArchiveOptions,
        ): Promise<LoadImageArchiveResponse>;
        version(): Promise<SemVer>;
    }

    Implemented by

    Index

    Methods

    buildNodeImage createCluster deleteCluster exportKubeConfig exportLogs getClusters getKubeConfig getNodes loadDockerImage loadImageArchive version

    Methods

    • Executes the Kind CLI cluster create sub-command.

      Parameters

      • OptionalclusterName: string

        the name of the cluster to create. If not provided, a default name will be used.

      • Optionaloptions: ClusterCreateOptions

        the options to use for creating the cluster. If not provided, default options will be used.

      Returns Promise<ClusterCreateResponse>

      the response of the create operation, which includes the name of the created cluster and other details.

    • Executes the Kind CLI kubeconfig export sub-command and returns the kubeconfig of the cluster.

      Parameters

      • OptionalclusterName: string

        the name of the cluster to export the kubeconfig from. If not provided, the default cluster will be used.

      Returns Promise<ExportKubeConfigResponse>

      the kubeconfig of the cluster.

    • Executes the Kind CLI cluster export sub-command and returns the logs of the cluster.

      Parameters

      • OptionalclusterName: string

        the name of the cluster to export logs from. If not provided, the default cluster will be used.

      Returns Promise<ExportLogsResponse>

      the logs of the cluster.

    • Executes the Kind CLI version sub-command and returns the reported version.

      Returns Promise<SemVer>

      the version of the Kind CLI that is being used by this client.

    Settings

    Member Visibility

    On This Page

    Methods