Guides
GuidesAPI ReferenceJoin the Mailing ListMake a Suggestion

Nodes

The orka node group of commands in the Orka CLI. These commands are used for node monitoring and management.

List nodes

Command

List Orka nodes with state and resource availability. Without any options specified, the command returns the worker nodes where Orka deployments are scheduled.

orka node list

OR 

orka node list -f all

Output

1600

Options

You can pass the following options with orka node list in direct mode:

OptionShorthand optionDescription
-filter-f(Administrative-only) Set to all to list all nodes
--jsonReturns the output of the command in JSON.
--rawReturns the output of the command in raw, greppable format.

Get node status

Command

Show status information, including sandbox status, for a selected node. The command also lists all available nodes.

orka node status

OR

orka node status -n <NODE> -y

Output

1580

Options

You can pass the following options with orka node status in direct mode:

OptionDescriptionSample value
-nThe name of the node.macpro-1
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Enable sandbox

Command

Enable sandbox mode for the node. This prevents Orka from managing deployments on the node and reserves it for Kubernetes-only deployments. This command requires additional administrative authentication with an Orka license key.

πŸ“˜

Sandbox is not required to use kubectl

kubectl works on all Orka clusters. Sandboxing is an easy way to cordon off nodes and prevent further deployment management with the basic Orka CLI.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support) to see which commands and options are supported.

orka node sandbox

OR

orka node sandbox -n <NODE> -y

Output

1592

Options

You can pass the following options with orka node sandbox in direct mode:

OptionDescriptionSample value
-nThe name of the node.macpro-1
-lAn Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally.orka-license-key
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Disable sandbox

Command

Disable sandbox mode for the specified node and expose it for deployment management with the Orka CLI. This command requires additional administrative authentication with an Orka license key.

🚧

Apple ARM-based nodes support

This command is not supported for Apple ARM-based nodes.
Read more about Apple ARM-based Support to see which commands and options are supported.

orka node unsandbox

OR

orka node unsandbox -n <NODE> -y

Output

1600

Options

You can pass the following options with orka node unsandbox in direct mode:

-nThe name of the node.macpro-1
-lAn Orka license key used for authentication against your Orka environment. Set this option, if you want to use a license key different from the one cached locally.orka-license-key
-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Manage node dedication

Command

Dedicate the specified node to the specified user group or remove an existing node dedication. This command requires additional administrative authentication with an Orka license key.

orka node group

OR

orka node group -g <GROUP> -n <NODE> -y

OR (to remove a node dedication)

orka node group -g -n <NODE> -y

Output

814

Options

You can pass the following options with orka node group in direct mode:

OptionShorthand optionDescriptionSample value
--node-nThe node to which you want to apply or remove a user group label.macpro-2
--group-gThe user group label that you want to apply. The label may or may not already exist.

To remove a group label, leave blank.
mygroup
--assume-yes-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Tag nodes (node affinity)

Command

Apply the specified tag to the specified node. Orka will automatically target this node or group of nodes when deploying VMs labeled with the same tag (in the VM config or during deployment). Based on the --tag-required setting of the VM, Orka might or might not try to deploy on additional nodes if the deployment on the tagged node(s) fails.

You can apply multiple tags to a single node. Run orka node tag for each tag separately.

πŸ“˜

Using both groups and tags in your cluster?

If you are a member of a user group, you can target only tagged nodes that are also dedicated to your user group. To check the current node dedication and node affinity settings of a node, run orka nodes.

orka node tag

OR 

orka node tag -n <NODE> --tag <TAG> -y

Output

930

Options

You can pass the following options with orka node tag in direct mode:

OptionShorthand optionDescriptionSample value
--node-nThe name of the node to which you want to apply the specified tag.mini-1
--tagThe tag to apply to the node.

The string must consist of lowercase and/or uppercase Latin alphanumeric characters, dashes (-), underscores (_), or periods (.). The string must begin and end with an alphanumeric character. The string must not exceed 63 characters.
myPool
--assume-yes-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Untag nodes (node affinity)

Command

Remove the specified tag from the specified node. You will no longer be able to target this node for deployment with the specified tag.

You cannot remove multiple tags at once. Run orka node untag for each tag you want to remove.

πŸ“˜

Are you cleaning up an existing tag from the cluster?

After you remove an existing tag from all the nodes it was applied to, you will no longer be able to deploy VMs with that tag and the --tag-required yes setting. You will need to override the node affinity settings on deployment or recreate the VM configs.

orka node untag

OR 

orka node untag -n <NODE> --tag <TAG> -y

Output

940

Options

You can pass the following options with orka node untag in direct mode:

OptionShorthand optionDescriptionSample value
--node-nThe name of the node for which you want to remove the specified tag.mini-1
--tagThe tag to remove from the node.myPool
--assume-yes-yBypasses the interactive prompt and executes the command with the specified parameters.
--jsonReturns the output of the command in JSON.

Β© 2019-2023 Copyright MacStadium, Inc. – Documentation built with readme.com. Orka is a registered trademark of MacStadium, Inc.