CLI Node Dedication

How to reserve nodes for a group of users with the Orka CLI. Administrators-only.

📘

BETA feature

Node grouping is currently in BETA.

🚧

Quick navigation

Jump to: 1. Grouping users | 2. Ungrouping users | 3. Dedicating nodes | 4. Removing node dedication

See also: How does node dedication work | Caveats

🚧

Quick command summary

orka user group --email <USER> --group <USER-GROUP>
orka node group --node <NODE> --group <USER-GROUP>
orka node list

If you need to limit the access to a node, you can use node dedication (also: node grouping).

Node dedication consists of two parts (performed in any order or any number of times within the current limitations of the feature):

1. Grouping users

You can add existing users to a user group. You can change the user group of any user at any time.
You cannot assign a user group during the creation of a new user. You need to create the user first and assign the group next.

Run:

orka user group --email <USER> --group <USER-GROUP> -y

Replace <USER> with the Orka user that you want to add to the group. The user must already exist. You can pass only one Orka user.
Replace <USER-GROUP> with the user group label. The label may or may not already exist.

If the Orka user is already grouped, you can overwrite their group with another one at any time.

👍

TIP

To check if a user already belongs to a user group, run orka user list.

2. Ungrouping users

To remove a user from a user group, just leave the --group option empty.

Run:

orka user group --email <USER> --group -y

Replace <USER> with the Orka user that you want to ungroup. The user must already exist. You can pass only one Orka user.
Leave the input for --group empty.

3. Dedicating nodes

Run:

orka node group --node <NODE> --group <USER-GROUP> -y

Replace <NODE> with the actual node names. For example: macpro-2.
Replace with the user group label. The label may or may not already exist.

If the node is already dedicated, you can overwrite their group label with another one at any time.

To check if the user label was properly applied, run:

orka node list

Orka will show your user group label in the Group column.

4. Removing node dedication

To remove the user group label for a node, just leave the --group option empty.

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

Replace <NODE> with the actual node names. For example: macpro-2.
Leave the input for --group empty.

To check if the user label was properly applied, run:

orka node list

Orka will not show a user group label in the Group column.

What's next

Create and deploy Orka virtual machines.

Updated 17 days ago


CLI Node Dedication


How to reserve nodes for a group of users with the Orka CLI. Administrators-only.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.


© 2019-2020 Copyright MacStadium, Inc. – Documentation built with readme.io. Orka is a registered trademark of MacStadium, Inc.