Class DefaultKindClient

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

Implements

KindClient

Index

Constructors

Methods

buildNodeImage checkVersion createCluster deleteCluster exportKubeConfig exportLogs getClusters getKubeConfig getNodes loadDockerImage loadImageArchive version

Constructors

constructor

new DefaultKindClient(
executable: string,
logger?: SoloLogger,
): DefaultKindClient
Parameters
- executable: string
- Optionallogger: SoloLogger
Returns DefaultKindClient
- Defined in src/integration/kind/impl/default-kind-client.ts:59

Methods

buildNodeImage

buildNodeImage(
options?: BuildNodeImagesOptions,
): Promise<BuildNodeImagesResponse>
Build the node image
Parameters
- Optionaloptions: BuildNodeImagesOptions
  the options to use for building the node images.
Returns Promise<BuildNodeImagesResponse>
the list of clusters.
Implementation of KindClient.buildNodeImage
- Defined in src/integration/kind/impl/default-kind-client.ts:113

checkVersion

checkVersion(): Promise<void>
Returns Promise<void>
- Defined in src/integration/kind/impl/default-kind-client.ts:70

createCluster

createCluster(
clusterName: string,
options?: ClusterCreateOptions,
): Promise<ClusterCreateResponse>
Executes the Kind CLI cluster create sub-command.
Parameters
- clusterName: 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.
Implementation of KindClient.createCluster
- Defined in src/integration/kind/impl/default-kind-client.ts:101

deleteCluster

deleteCluster(
clusterName?: string,
options?: ClusterDeleteOptions,
): Promise<ClusterDeleteResponse>
Executes the Kind CLI cluster delete sub-command and returns the result.
Parameters
- OptionalclusterName: string
  the name of the cluster to delete. If not provided, the default cluster will be deleted.
- Optionaloptions: ClusterDeleteOptions
  the options to use for deleting the cluster. If not provided, default options will be used.
Returns Promise<ClusterDeleteResponse>
the response of the delete operation.
Implementation of KindClient.deleteCluster
- Defined in src/integration/kind/impl/default-kind-client.ts:107

exportKubeConfig

exportKubeConfig(clusterName?: string): Promise<ExportKubeConfigResponse>
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.
Implementation of KindClient.exportKubeConfig
- Defined in src/integration/kind/impl/default-kind-client.ts:122

exportLogs

exportLogs(clusterName?: string): Promise<ExportLogsResponse>
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.
Implementation of KindClient.exportLogs
- Defined in src/integration/kind/impl/default-kind-client.ts:117

getClusters

getClusters(): Promise<KindCluster[]>
Returns a list of clusters that are managed by Kind.

Returns Promise<KindCluster[]>
a list of cluster names.
Implementation of KindClient.getClusters
- Defined in src/integration/kind/impl/default-kind-client.ts:127

getKubeConfig

getKubeConfig(
contextName?: string,
options?: GetKubeConfigOptions,
): Promise<GetKubeConfigResponse>
Returns the kubeconfig of the specified cluster.
Parameters
- OptionalcontextName: string
  the name of the cluster context to get the kubeconfig from.
- Optionaloptions: GetKubeConfigOptions
  the options to use for getting the kubeconfig.
Returns Promise<GetKubeConfigResponse>
the kubeconfig of the cluster.
Implementation of KindClient.getKubeConfig
- Defined in src/integration/kind/impl/default-kind-client.ts:136

getNodes

getNodes(
contextName?: string,
options?: GetNodesOptions,
): Promise<GetNodesResponse>
Returns a list of nodes in the specified cluster.
Parameters
- OptionalcontextName: string
  the name of the cluster context to get nodes from.
- Optionaloptions: GetNodesOptions
  the options to use for getting nodes.
Returns Promise<GetNodesResponse>
a list of node names.
Implementation of KindClient.getNodes
- Defined in src/integration/kind/impl/default-kind-client.ts:131

loadDockerImage

loadDockerImage(
imageName: string,
options?: LoadDockerImageOptions,
): Promise<LoadDockerImageResponse>
Loads the specified images into the Kind cluster.
Parameters
- imageName: string
  the names of the images to load.
- Optionaloptions: LoadDockerImageOptions
  the options to use for loading the images
Returns Promise<LoadDockerImageResponse>
Implementation of KindClient.loadDockerImage
- Defined in src/integration/kind/impl/default-kind-client.ts:141

loadImageArchive

loadImageArchive(
imageName: string,
options?: LoadImageArchiveOptions,
): Promise<LoadImageArchiveResponse>
Loads an image archive into the Kind cluster.
Parameters
- imageName: string
  the name of the images to load from the archive.
- Optionaloptions: LoadImageArchiveOptions
  the options to use for loading the image archive
Returns Promise<LoadImageArchiveResponse>
Implementation of KindClient.loadImageArchive
- Defined in src/integration/kind/impl/default-kind-client.ts:146

version

version(): Promise<SemVer>
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.
Implementation of KindClient.version
- Defined in src/integration/kind/impl/default-kind-client.ts:79

Class DefaultKindClient

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns DefaultKindClient

Methods

buildNodeImage

Parameters

Returns Promise<BuildNodeImagesResponse>

checkVersion

Returns Promise<void>

createCluster

Parameters

Returns Promise<ClusterCreateResponse>

deleteCluster

Parameters

Returns Promise<ClusterDeleteResponse>

exportKubeConfig

Parameters

Returns Promise<ExportKubeConfigResponse>

exportLogs

Parameters

Returns Promise<ExportLogsResponse>

getClusters

Returns Promise<KindCluster[]>

getKubeConfig

Parameters

Returns Promise<GetKubeConfigResponse>

getNodes

Parameters

Returns Promise<GetNodesResponse>

loadDockerImage

Parameters

Returns Promise<LoadDockerImageResponse>

loadImageArchive

Parameters

Returns Promise<LoadImageArchiveResponse>

version

Returns Promise<SemVer>

Settings

On This Page