replicated

Run commands using the replicated CLI

Installation

dagger install github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3

Entrypoint

Return Type

Replicated !

Arguments

Name	Type	Default Value	Description
token	Secret !	-	No description provided
apiOrigin	String	-	No description provided
idOrigin	String	-	No description provided
registryOrigin	String	-	No description provided

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET

func (m *MyModule) Example(token *dagger.Secret) *dagger.Replicated  {
	return dag.
			Replicated(token)
}

@function
def example(token: dagger.Secret, ) -> dagger.Replicated:
	return (
		dag.replicated(token)
	)

@func()
example(token: Secret, ): Replicated {
	return dag
		.replicated(token)
}

Types

Replicated 🔗

Replicated is a Dagger module that provides access to the replicated CLI

token() 🔗

Return Type

Secret !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET token

func (m *MyModule) Example(token *dagger.Secret) *dagger.Secret  {
	return dag.
			Replicated(token).
			Token()
}

@function
def example(token: dagger.Secret, ) -> dagger.Secret:
	return (
		dag.replicated(token)
		.token()
	)

@func()
example(token: Secret, ): Secret {
	return dag
		.replicated(token)
		.token()
}

apiorigin() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET apiorigin

func (m *MyModule) Example(ctx context.Context, token *dagger.Secret) string  {
	return dag.
			Replicated(token).
			Apiorigin(ctx)
}

@function
async def example(token: dagger.Secret, ) -> str:
	return await (
		dag.replicated(token)
		.apiorigin()
	)

@func()
async example(token: Secret, ): Promise<string> {
	return dag
		.replicated(token)
		.apiorigin()
}

idorigin() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET idorigin

func (m *MyModule) Example(ctx context.Context, token *dagger.Secret) string  {
	return dag.
			Replicated(token).
			Idorigin(ctx)
}

@function
async def example(token: dagger.Secret, ) -> str:
	return await (
		dag.replicated(token)
		.idorigin()
	)

@func()
async example(token: Secret, ): Promise<string> {
	return dag
		.replicated(token)
		.idorigin()
}

registryOrigin() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET registry-origin

func (m *MyModule) Example(ctx context.Context, token *dagger.Secret) string  {
	return dag.
			Replicated(token).
			RegistryOrigin(ctx)
}

@function
async def example(token: dagger.Secret, ) -> str:
	return await (
		dag.replicated(token)
		.registry_origin()
	)

@func()
async example(token: Secret, ): Promise<string> {
	return dag
		.replicated(token)
		.registryOrigin()
}

clusterCreate() 🔗

Create a new CMX cluster

Example:

dagger call -m github.com/replicatedhq/daggerverse/replicated –token=env:REPLICATED_API_TOKEN cluster-create –name=my-cluster –wait=10m –ttl=20m –distribution=k3s –version=1.31.0

Return Type

Cluster !

Arguments

Name	Type	Default Value	Description
name	String	-	Name of the cluster
wait	String !	"15m"	How long to wait for the cluster to be ready
ttl	String !	"20m"	TTL of the cluster
distribution	String !	"k3s"	Distribution to use
version	String	-	Version of the distribution to use
nodes	Integer !	"1"	Number of nodes to create

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET cluster-create --wait string --ttl string --distribution string --nodes integer

func (m *MyModule) Example(token *dagger.Secret, wait string, ttl string, distribution string, nodes int) *dagger.ReplicatedCluster  {
	return dag.
			Replicated(token).
			ClusterCreate(wait, ttl, distribution, nodes)
}

@function
def example(token: dagger.Secret, wait: str, ttl: str, distribution: str, nodes: int) -> dagger.ReplicatedCluster:
	return (
		dag.replicated(token)
		.cluster_create(wait, ttl, distribution, nodes)
	)

@func()
example(token: Secret, wait: string, ttl: string, distribution: string, nodes: number): ReplicatedCluster {
	return dag
		.replicated(token)
		.clusterCreate(wait, ttl, distribution, nodes)
}

clusterRemove() 🔗

Remove a CMX cluster

Example:

dagger call –token=env:REPLICATED_API_TOKEN cluster-remove –cluster-id=my-cluster

Return Type

String !

Arguments

Name	Type	Default Value	Description
clusterId	String !	-	Cluster ID of the cluster to remove

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET cluster-remove --cluster-id string

func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, clusterId string) string  {
	return dag.
			Replicated(token).
			ClusterRemove(ctx, clusterId)
}

@function
async def example(token: dagger.Secret, cluster_id: str) -> str:
	return await (
		dag.replicated(token)
		.cluster_remove(cluster_id)
	)

@func()
async example(token: Secret, clusterId: string): Promise<string> {
	return dag
		.replicated(token)
		.clusterRemove(clusterId)
}

clusterExposePort() 🔗

Expose a port on a CMX cluster, returning the hostname of the exposed port

Example:

dagger call –token=env:REPLICATED_API_TOKEN cluster-expose-port –cluster-id=my-cluster –node-port=80

Return Type

String !

Arguments

Name	Type	Default Value	Description
clusterId	String !	-	Cluster ID of the cluster to remove
nodePort	Integer !	-	Port to expose

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET cluster-expose-port --cluster-id string --node-port integer

func (m *MyModule) Example(ctx context.Context, token *dagger.Secret, clusterId string, nodePort int) string  {
	return dag.
			Replicated(token).
			ClusterExposePort(ctx, clusterId, nodePort)
}

@function
async def example(token: dagger.Secret, cluster_id: str, node_port: int) -> str:
	return await (
		dag.replicated(token)
		.cluster_expose_port(cluster_id, node_port)
	)

@func()
async example(token: Secret, clusterId: string, nodePort: number): Promise<string> {
	return dag
		.replicated(token)
		.clusterExposePort(clusterId, nodePort)
}

clusterVersions() 🔗

Get the available cluster versions

Example:

dagger call –token=env:REPLICATED_API_TOKEN cluster-versions

Return Type

[ClusterVersion ! ] !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET cluster-versions

func (m *MyModule) Example(token *dagger.Secret) []*dagger.ReplicatedClusterVersion  {
	return dag.
			Replicated(token).
			ClusterVersions()
}

@function
def example(token: dagger.Secret, ) -> List[dagger.ReplicatedClusterVersion]:
	return (
		dag.replicated(token)
		.cluster_versions()
	)

@func()
example(token: Secret, ): ReplicatedClusterVersion[] {
	return dag
		.replicated(token)
		.clusterVersions()
}

container() 🔗

Obtain the base container with the replicated CLI installed at /replicated

Return Type

Container !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 --token env:MYSECRET container

func (m *MyModule) Example(token *dagger.Secret) *dagger.Container  {
	return dag.
			Replicated(token).
			Container()
}

@function
def example(token: dagger.Secret, ) -> dagger.Container:
	return (
		dag.replicated(token)
		.container()
	)

@func()
example(token: Secret, ): Container {
	return dag
		.replicated(token)
		.container()
}

Cluster 🔗

Cluster is a struct representing a CMX cluster

clusterId() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 cluster-create --wait string --ttl string --distribution string --nodes integer \
 cluster-id

func (m *MyModule) Example(ctx context.Context, wait string, ttl string, distribution string, nodes int) string  {
	return dag.
			Replicated().
			ClusterCreate(wait, ttl, distribution, nodes).
			ClusterId(ctx)
}

@function
async def example(wait: str, ttl: str, distribution: str, nodes: int) -> str:
	return await (
		dag.replicated()
		.cluster_create(wait, ttl, distribution, nodes)
		.cluster_id()
	)

@func()
async example(wait: string, ttl: string, distribution: string, nodes: number): Promise<string> {
	return dag
		.replicated()
		.clusterCreate(wait, ttl, distribution, nodes)
		.clusterId()
}

status() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 cluster-create --wait string --ttl string --distribution string --nodes integer \
 status

func (m *MyModule) Example(ctx context.Context, wait string, ttl string, distribution string, nodes int) string  {
	return dag.
			Replicated().
			ClusterCreate(wait, ttl, distribution, nodes).
			Status(ctx)
}

@function
async def example(wait: str, ttl: str, distribution: str, nodes: int) -> str:
	return await (
		dag.replicated()
		.cluster_create(wait, ttl, distribution, nodes)
		.status()
	)

@func()
async example(wait: string, ttl: string, distribution: string, nodes: number): Promise<string> {
	return dag
		.replicated()
		.clusterCreate(wait, ttl, distribution, nodes)
		.status()
}

kubeconfig() 🔗

Return Type

String !

Example

dagger -m github.com/replicatedhq/daggerverse/replicated@6c6dba3b71a30bf03edc7be56e87941cb021f0d3 call \
 cluster-create --wait string --ttl string --distribution string --nodes integer \
 kubeconfig

func (m *MyModule) Example(ctx context.Context, wait string, ttl string, distribution string, nodes int) string  {
	return dag.
			Replicated().
			ClusterCreate(wait, ttl, distribution, nodes).
			Kubeconfig(ctx)
}

@function
async def example(wait: str, ttl: str, distribution: str, nodes: int) -> str:
	return await (
		dag.replicated()
		.cluster_create(wait, ttl, distribution, nodes)
		.kubeconfig()
	)

@func()
async example(wait: string, ttl: string, distribution: string, nodes: number): Promise<string> {
	return dag
		.replicated()
		.clusterCreate(wait, ttl, distribution, nodes)
		.kubeconfig()
}

ClusterVersion 🔗

shortName() 🔗

Return Type

String !

Example

Function ReplicatedClusterVersion.shortName is not accessible from the replicated module

Function ReplicatedClusterVersion.shortName is not accessible from the replicated module

Function ReplicatedClusterVersion.shortName is not accessible from the replicated module

Function ReplicatedClusterVersion.shortName is not accessible from the replicated module

versions() 🔗

Return Type

[String ! ] !

Example

Function ReplicatedClusterVersion.versions is not accessible from the replicated module

Function ReplicatedClusterVersion.versions is not accessible from the replicated module

Function ReplicatedClusterVersion.versions is not accessible from the replicated module

Function ReplicatedClusterVersion.versions is not accessible from the replicated module

instanceTypes() 🔗

Return Type

[String ! ] !

Example

Function ReplicatedClusterVersion.instanceTypes is not accessible from the replicated module

Function ReplicatedClusterVersion.instanceTypes is not accessible from the replicated module

Function ReplicatedClusterVersion.instanceTypes is not accessible from the replicated module

Function ReplicatedClusterVersion.instanceTypes is not accessible from the replicated module

nodesMax() 🔗

Return Type

Integer !

Example

Function ReplicatedClusterVersion.nodesMax is not accessible from the replicated module

Function ReplicatedClusterVersion.nodesMax is not accessible from the replicated module

Function ReplicatedClusterVersion.nodesMax is not accessible from the replicated module

Function ReplicatedClusterVersion.nodesMax is not accessible from the replicated module