1. Description

Credentials in the Aether platform enable secure connections to external services and resources, including:

• Docker registries
• Cloud storage services (S3, Google cloud storage, azure blob)

By managing credentials through Aether, users can:

• Securely store authentication information
• Configure access to multiple external services
• Quickly update and rotate credentials
• Maintain granular control over service connections

2. Prerequisites

• Alteia CLI installed
• Required authentication details for the target service (e.g., Docker registry credentials, S3 access keys)

3. Create your credential

step 1 : Prepare Credentials JSON File

Example of credential for docker registry

{
  "name": "YourCredentialName",
  "company": "YourCompany",
  "credentials": {
    	"Credential-param1": "Credential-param1-value",
    "Credential-param2": "Credential-param2-value"
      },
  "labels": {
    "label1": "label1-value"
  }
}

Credential section describe the required information to connect to the external service.

For Docker Registry credential, the needed information is : “registry”, “login” and “password”

For S3 credential,  the needed information is : “bucket”, “aws_access_key_id”, “aws_secret_access_key” and “aws_region”

For Azure Blob,  the needed information is : “account_url”, “azure_client_id”, “azure_tenant_id” and “azure_client_secret”

For Google Cloud Storage,  the needed information is : “project_id”, “private_key”, “client_email”, “token_uri” and “bucket”

Label section is a free section allowing users to add a description or note to easily find their credential

step 2 : create credentials

Run the following command:

alteia credentials create --filepath [credentials-file.json] --company [company-id]

step 3 : verify the creation of your credential 

List credentials to confirm creation:

 alteia credentials list --filepath [credentials-file.json] --company [company-id]

4. Update Credentials Details

Step 1 : Modify the credentials section in JSON file:

{
  
    "Credential-param1": "Credential-param1-value",
    "Credential-param2": "Credential-param2-value"  
}

Step 2 : Update the credentials section

alteia credentials set-credentials [credential-name] --filepath [credentials-file.json] --company [company-id]

5. Update Labels

Step 1 : Modify the labels section in JSON file:

    {
    "label1": "label1-value",
    "label2": "label2-value"  
  }

Step 2 : Update the credentials section

alteia credentials set-labels [credential-name] --filepath [labels-file.json] --company [company-id]

6. Delete your credentials

Remove credentials using the CLI:

alteia credentials delete [credential-name] --company [company-id]

7. Notes

• Replace placeholders (e.g., [credential-name], [company-id]) with your actual values
• Ensure you have the necessary permissions to manage credentials
• Keep credential files secure and do not share them