Last modified May 30, 2023
'gsctl update organization set-credentials' command reference
gsctl and the REST API are being phased out. We recommend to familiarize yourself with our Management API and the kubectl gs plugin as a future-proof replacement. We provide a migration page to help you with the transition.
Giant Swarm allows you to run clusters in your own cloud provider account/subscription. We refer to this as multi-account functionality. As a prerequisite, the organization that should own the clusters has to be prepared with cloud provider credentials.
Please refer to our detailed guides on how to prepare roles and credentials in your AWS account or Azure subscription:
- Prepare an AWS account to run Giant Swarm workload clusters
- Prepare an Azure subscription to run Giant Swarm workload clusters
gsctl provides this command to store the credentials connected to your organization. After doing this, you will want to create a cluster owned by the organization configured that way.
Note: The credentials of an organization are currently immutable. Once set, you cannot modify or remove them. However you can create and delete organizations at will.
Regardless of your cloud provider, you need an organization to work with. If you haven’t created one for the purpose yet, this can be done in our web user interface.
In this gsctl command, the flag
--organization specifies the organization to set the credentials for.
For AWS you provide two ARN (Amazon Resource Name) strings for two separate roles. Here is the general syntax:
gsctl update organization set-credentials \ -o|--organization <org-id> \ --aws-operator-role <role-arn> \ --aws-admin-role <role-arn>
--aws-operator-role flag defines the role ARN for the role to be used by our software running the clusters in your account. The
--aws-admin-role flag takes the ARN or a role to be assumed by our support staff members. Both are mandatory.
For example, if your organization name was
myorg and your AWS account ID was
0123456789, the command would be:
gsctl update organization set-credentials \ -o myorg \ --aws-operator-role arn:aws:iam::0123456789:role/GiantSwarmAWSOperator \ --aws-admin-role arn:aws:iam::0123456789:role/GiantSwarmAdmin
For Azure you provide four credential details. Here is the general syntax:
gsctl update organization set-credentials \ -o|--organization <org-id> \ --azure-subscription-id <subcription-id> \ --azure-tenant-id <tenant-id> \ --azure-client-id <client-id> \ --azure-secret-key <secret-key> \
The flags mean:
--azure-subscription-id: ID of your Azure subscription
--azure-tenant-id: ID of the tenant to use within your subscription
--azure-client-id: ID of the service principal to use by our software and staff
--azure-secret-key: Secret key for the above service principal
- Basics and Concepts: Multi-Account Support
- Guides: Prepare an AWS account to run Giant Swarm workload clusters
- Guides: Prepare an Azure subscription to run Giant Swarm workload clusters
- API: Set credentials
Need help, got feedback?
We listen to your Slack support channel. You can also reach us at email@example.com. And of course, we welcome your pull requests!