`orca coe`¶

Magnum Container Orchestration Engine (OSC-parity top-level).

The reference below is generated from the live CLI by mkdocs-click. It always reflects the version installed.

orca coe¶

Magnum Container Orchestration Engine — OSC parity top-level.

Usage:

orca coe [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

cluster: Manage Kubernetes clusters & cluster templates (Magnum).

orca coe cluster¶

Manage Kubernetes clusters & cluster templates (Magnum).

Usage:

orca coe cluster [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a Kubernetes cluster.
delete: Delete a cluster.
kubeconfig: Show the cluster API address and connection info.
list: List clusters.
nodegroup: Manage node groups in a cluster.
nodegroup-create: [deprecated, use 'cluster nodegroup create' instead]
nodegroup-delete: [deprecated, use 'cluster nodegroup delete' instead]
nodegroup-list: [deprecated, use 'cluster nodegroup list' instead]
nodegroup-show: [deprecated, use 'cluster nodegroup show' instead]
nodegroup-update: [deprecated, use 'cluster nodegroup update' instead]
resize: Resize a cluster (change worker node count).
show: Show cluster details.
template: Manage cluster templates.
template-create: [deprecated, use 'cluster template create' instead]
template-delete: [deprecated, use 'cluster template delete' instead]
template-list: [deprecated, use 'cluster template list' instead]
template-show: [deprecated, use 'cluster template show' instead]
upgrade: Upgrade a cluster to a new template version.

orca coe cluster create¶

Create a Kubernetes cluster.

Examples: orca cluster create my-k8s --template --node-count 3 orca cluster create prod --template --master-count 3 --node-count 5 --keypair my-key

Usage:

orca coe cluster create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--template`	text	Cluster template UUID or name.	`Sentinel.UNSET`
`--node-count`	integer	Number of worker nodes.	`1`
`--master-count`	integer	Number of master nodes.	`1`
`--keypair`	text	SSH keypair name.	None
`--timeout`	integer	Creation timeout (minutes).	`60`
`--flavor`	text	Node flavor (overrides template).	None
`--master-flavor`	text	Master flavor (overrides template).	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster delete¶

Delete a cluster.

Usage:

orca coe cluster delete [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster kubeconfig¶

Show the cluster API address and connection info.

Usage:

orca coe cluster kubeconfig [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster list¶

List clusters.

Usage:

orca coe cluster list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup¶

Manage node groups in a cluster.

Usage:

orca coe cluster nodegroup [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a node group in a cluster.
delete: Delete a node group.
list: List node groups in a cluster.
show: Show node group details.
update: Update a node group (resize / autoscaling bounds).

orca coe cluster nodegroup create¶

Create a node group in a cluster.

Usage:

orca coe cluster nodegroup create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup delete¶

Delete a node group.

Usage:

orca coe cluster nodegroup delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup list¶

List node groups in a cluster.

Usage:

orca coe cluster nodegroup list [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup show¶

Show node group details.

Usage:

orca coe cluster nodegroup show [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca coe cluster nodegroup update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-create¶

Create a node group in a cluster.

Usage:

orca coe cluster nodegroup-create [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--name`	text	Node group name.	`Sentinel.UNSET`
`--flavor-id`	text	Flavor ID for nodes.	`Sentinel.UNSET`
`--node-count`	integer	Initial number of nodes.	`1`
`--min-node-count`	integer	Minimum node count (for autoscaling).	None
`--max-node-count`	integer	Maximum node count (for autoscaling).	None
`--role`	text	Node group role (worker/infra).	`worker`
`--image-id`	text	Override image ID.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-delete¶

Delete a node group.

Usage:

orca coe cluster nodegroup-delete [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-list¶

List node groups in a cluster.

Usage:

orca coe cluster nodegroup-list [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-show¶

Show node group details.

Usage:

orca coe cluster nodegroup-show [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster nodegroup-update¶

Update a node group (resize / autoscaling bounds).

Usage:

orca coe cluster nodegroup-update [OPTIONS] CLUSTER_ID NODEGROUP_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New node count.	None
`--min-node-count`	integer	New minimum node count.	None
`--max-node-count`	integer	New maximum node count.	None
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster resize¶

Resize a cluster (change worker node count).

Usage:

orca coe cluster resize [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--node-count`	integer	New number of worker nodes.	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster show¶

Show cluster details.

Usage:

orca coe cluster show [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template¶

Manage cluster templates.

Usage:

orca coe cluster template [OPTIONS] COMMAND [ARGS]...

Options:

Name	Type	Description	Default
`--help`	boolean	Show this message and exit.	`False`

Subcommands

create: Create a cluster template.
delete: Delete a cluster template.
list: List cluster templates.
show: Show cluster template details.

orca coe cluster template create¶

Create a cluster template.

Usage:

orca coe cluster template create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template delete¶

Delete a cluster template.

Usage:

orca coe cluster template delete [OPTIONS] TEMPLATE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template list¶

List cluster templates.

Usage:

orca coe cluster template list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template show¶

Show cluster template details.

Usage:

orca coe cluster template show [OPTIONS] TEMPLATE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template-create¶

Create a cluster template.

Usage:

orca coe cluster template-create [OPTIONS] NAME

Options:

Name	Type	Description	Default
`--image`	text	Base image UUID or name.	`Sentinel.UNSET`
`--external-network`	text	External network ID.	`Sentinel.UNSET`
`--coe`	choice (`kubernetes` \| `swarm` \| `mesos`)	N/A	`kubernetes`
`--keypair`	text	SSH keypair name.	None
`--flavor`	text	Node flavor.	None
`--master-flavor`	text	Master flavor.	None
`--network-driver`	text	Network driver (flannel, calico, etc.).	None
`--docker-volume-size`	integer	Docker volume size in GB.	None
`--dns`	text	DNS nameserver.	`8.8.8.8`
`--master-lb` / `--no-master-lb`	boolean	N/A	`True`
`--floating-ip` / `--no-floating-ip`	boolean	N/A	`True`
`--label`	text	Key=value label (repeatable). E.g. --label boot_volume_size=20	`Sentinel.UNSET`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template-delete¶

Delete a cluster template.

Usage:

orca coe cluster template-delete [OPTIONS] TEMPLATE_ID

Options:

Name	Type	Description	Default
`--yes`, `-y`	boolean	Skip confirmation.	`False`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template-list¶

List cluster templates.

Usage:

orca coe cluster template-list [OPTIONS]

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster template-show¶

Show cluster template details.

Usage:

orca coe cluster template-show [OPTIONS] TEMPLATE_ID

Options:

Name	Type	Description	Default
`--noindent`	boolean	Disable JSON indentation.	`False`
`--max-width`	integer	Maximum table width (0 = unlimited).	None
`--fit-width`	boolean	Fit table to terminal width.	`False`
`--column`, `-c`	text	Column to include (repeatable). Shows all if omitted.	`Sentinel.UNSET`
`--format`, `-f`	choice (`table` \| `json` \| `value`)	Output format.	`table`
`--help`	boolean	Show this message and exit.	`False`

orca coe cluster upgrade¶

Upgrade a cluster to a new template version.

Usage:

orca coe cluster upgrade [OPTIONS] CLUSTER_ID

Options:

Name	Type	Description	Default
`--template-id`	text	New cluster template ID to upgrade to.	`Sentinel.UNSET`
`--max-batch-size`	integer	Max number of nodes to upgrade simultaneously.	`1`
`--nodegroup`	text	Specific nodegroup to upgrade.	None
`--help`	boolean	Show this message and exit.	`False`