How to Identify your Organization's claimed namespace using the CircleCI CLI

Introduction:

The CircleCI namespace claimed by your organization is used for Runner Resource Classes as well as your Orb namespace. While this is not something that is visible in the UI, outside of the runner inventory page if your team has configured runners, it is helpful to identify your team's namespace for creating aforementioned Orbs and Runner Resoure Classes.

This information can be identified using the CircleCI CLI

Prerequisites:

Please read through the entire process to ensure a namespace isn't unintentionally claimed if your organization has not claimed one already

  • CircleCI CLI installed on your local machine
  • The name of the organization you are checking the namespace for
  • A valid Personal API token to authenticate when using the CLI

Instructions:

  1. Ensure your CircleCI CLI is up to date and has a token configured
    • Running circleci setup will check for any available updates and ensure that it is set up with a token
    • If there is a valid token configured already, there is no need change it when prompted with the following
      • A CircleCI token is already set. Do you want to change it Yes ▸No
  2. Run the command to create a namespace
  3. Receive the output of existing owned namespace upon answering Yes to the following prompt
    • You are creating a namespace called "<desired-namespace-name>".
      
      This is the only namespace permitted for your github organization, <org-here>.
      
      To change the namespace, you will have to contact CircleCI customer support.
      
      Are you sure you wish to create the namespace: `<desired-namespace-name>` Yes
      Error: Organizations may only create one namespace. This organization owns the following namespace: "<existing-namespace-name>"

Outcome:

Upon completion, your team will be aware of the existing namespace or have created one that's ready for orb and Self-Hosted Runner utilization on CircleCI.

Additional Notes:

  • If your organization account has not claimed a namespace, this will create a namespace when running the circleci namespace create in Step 2
  • The CircleCI Support Engineering team can rename the namespace for your team provided that (1) it is requested by the organization admin and (2) the desired namespace name has not been claimed by another organization using CircleCI.
  • It is also possible to use your organization ID found in the Organization Settings page
    • circleci namespace create <desired-namespace-name> --org-id <your-org-id>

Additional Resources:

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.