Updating an OKS Profile

You can update an OKS profile using OKS CLI.

Updating an OKS Profile Using OKS CLI

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

The profile update command allows you to modify the Region and corresponding endpoint of one of your OKS profiles.

Request sample
$ oks-cli profile update \
    --profile-name "NAME_OF_PROFILE" \
    --new-name "NEW_PROFILE_NAME" \
    --region "REGION_NAME"

This command contains the following options that you need to specify:

  • profile-name: The name of the profile that you want to update.

  • (optional) new-name: The new name of the profile that you want to update.

Make sure to update all dependent configurations after renaming to avoid inconsistencies.

When you rename a profile, you are prompted for confirmation before the change is applied.

  • (optional) endpoint: The endpoint you want to update the profile to.

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

  • (optional) region: The updated Region for the profile (eu-west-2 | cloudgouv-eu-west-1).

The profile is updated with the new information you specified.

Result sample
Profile default has been successfully updated

Related Pages

Export to PDF