Dagger
Search

civo-cluster

Functions for working with k3s clusters in Civo

Installation

dagger install github.com/civo/dagger-modules/civo-cluster@b3347ef4304633bb35274f95ca0c8859a913b456

Entrypoint

Return Type 
CivoCluster
Example
func (m *myModule) example() *CivoCluster  {
	return dag.
			CivoCluster()
}
@function
def example() -> dag.CivoCluster:
	return (
		dag.civo_cluster()
	)
@func()
example(): CivoCluster {
	return dag
		.civoCluster()
}

Types

CivoCluster

clusterList()

example usage: “dagger call cluster-list –api-key –region ”

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiTokenSecret !-apiKey API key used to against the Civo API. Found at https://dashboard.civo.com/account/api
regionString !-region The region to list clusters in
Example
dagger -m github.com/civo/dagger-modules/civo-cluster@b3347ef4304633bb35274f95ca0c8859a913b456 call \
 cluster-list --api-token env:MYSECRET --region string
func (m *myModule) example(ctx context.Context, apiToken *Secret, region string) string  {
	return dag.
			CivoCluster().
			ClusterList(ctx, apiToken, region)
}
@function
async def example(api_token: dagger.Secret, region: str) -> str:
	return await (
		dag.civo_cluster()
		.cluster_list(api_token, region)
	)
@func()
async example(apiToken: Secret, region: string): Promise<string> {
	return dag
		.civoCluster()
		.clusterList(apiToken, region)
}

clusterShow()

example usage: “dagger call cluster-show –api-key –region –name ”

Return Type 
String !
Arguments
NameTypeDefault ValueDescription
apiTokenSecret !-No description provided
regionString !-No description provided
nameString !-No description provided
Example
dagger -m github.com/civo/dagger-modules/civo-cluster@b3347ef4304633bb35274f95ca0c8859a913b456 call \
 cluster-show --api-token env:MYSECRET --region string --name string
func (m *myModule) example(ctx context.Context, apiToken *Secret, region string, name string) string  {
	return dag.
			CivoCluster().
			ClusterShow(ctx, apiToken, region, name)
}
@function
async def example(api_token: dagger.Secret, region: str, name: str) -> str:
	return await (
		dag.civo_cluster()
		.cluster_show(api_token, region, name)
	)
@func()
async example(apiToken: Secret, region: string, name: string): Promise<string> {
	return dag
		.civoCluster()
		.clusterShow(apiToken, region, name)
}

version()

example usage: “dagger call version”

Return Type 
String !
Example
dagger -m github.com/civo/dagger-modules/civo-cluster@b3347ef4304633bb35274f95ca0c8859a913b456 call \
 version
func (m *myModule) example(ctx context.Context) string  {
	return dag.
			CivoCluster().
			Version(ctx)
}
@function
async def example() -> str:
	return await (
		dag.civo_cluster()
		.version()
	)
@func()
async example(): Promise<string> {
	return dag
		.civoCluster()
		.version()
}