Adding an OKS Profile to Your Outscale Account

Access to Kubernetes clusters using OKS CLI is managed through profiles. You can add an OKS profile to your Outscale account using OKS CLI.

Profiles are Outscale accounts with a defined project and cluster limit added to your OKS-cli. Profiles help organize projects by grouping them under a common subject or end-client, keep billing separate for better financial management, and provide clearer cost tracking with dedicated billing accounts.

Once you have added and tested your profile, you can proceed with Managing Your Projects Using OKS CLI.

Adding an OKS Profile to Your Outscale Account Using OKS CLI

Before you begin: Install and configure OKS CLI. For more information, see Installing and Configuring OKS CLI.

The profile add command allows you to set an existing Outscale account as an OKS profile:

Request sample
oks-cli profile add \
    --profile-name "default" \
    --username "MY_LOGIN" // --access-key "MY_ACCESS_KEY" \
    --password "MY_ACOUNT_PASSWORD" // --secret-key "MY_SECRET_KEY" \
    --region "eu-west-2" \
    --jwt false
shell

The profile add command contains the following options that you need to specify:

  • (optional) profile-name: The name of the profile being added.

    • By default, default.

    • If you do not create a default profile, you will have to explicitly specify the profile you want to use in other oks-cli commands, with their --profile parameter.

  • username and password: Used for login/password authentication:

    • username: Your login (username or email address) associated with your Outscale account.

    • password: The password of your Outscale account.

  • access-key / secret-key: Used for access key/secret key authentication:

    • access-key: Your access key.

    • secret-key: Your secret key.

  • region: The Region of your OUTSCALE account, where you want to deploy and manage your OKS clusters.

  • (optional) endpoint: The endpoint corresponding to the Region you want to send the request to. By default, the Region you set in your oks-cli configuration is used. For more information, see API Endpoints Reference.

  • (optional) jwt: Determines whether JWT (JSON Web Token) authentication is enabled, either true or false. By default, false.

The profile is added.

Result sample
Profile default has been successfully added
text

Related Pages