Skip to content

generated documentation

Jump to bottom
GitHub Action edited this page Oct 2, 2023 · 9 revisions

Otc-Auth Manual

OTC-Auth Command Line Interface for managing OTC clouds

otc-auth [command] [global flags] [command flags]

Global Flags

      --skip-tls-verification   Skip TLS Verification. This is insecure. Either provide this argument or set the environment variable SKIP_TLS_VERIFICATION

Commands

Commands

otc-auth access-token

Manage AK/SK

otc-auth access-token [flags]

Command Flags

  -h, --help                    help for access-token
  -d, --os-domain-name string   OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME

otc-auth access-token create

Create new AK/SK

otc-auth access-token create [flags]

Command Flags

  -s, --description string   Description of the token (default "Token by otc-auth")
  -h, --help                 help for create

otc-auth access-token delete

Delete existing AK/SKs

otc-auth access-token delete [flags]

Command Flags

  -h, --help           help for delete
  -t, --token string   The AK/SK token to delete

otc-auth access-token help

Help about any command

otc-auth access-token help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth access-token list

List existing AK/SKs

otc-auth access-token list [flags]

Command Flags

  -h, --help   help for list

otc-auth cce

Manage Cloud Container Engine

otc-auth cce [flags]

Command Flags

  -h, --help                     help for cce
  -d, --os-domain-name string    OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME
  -p, --os-project-name string   Name of the project you want to access. Either provide this argument or set the environment variable OS_PROJECT_NAME

otc-auth cce get-kube-config

Get remote kube config and merge it with existing local config file

otc-auth cce get-kube-config [flags]

Command Flags

  -c, --cluster string           Name of the clusterArg you want to access. Either provide this argument or set the environment variable CLUSTER_NAME
  -v, --days-valid int           Period (in days) that the config will be valid (default 7)
  -h, --help                     help for get-kube-config
  -r, --region string            OTC region code. Either provide this argument or set the environment variable REGION
  -s, --server string            Override the server attribute in the kube config with the specified value
  -l, --target-location string   Where the kube config should be saved (default "~/.kube/config")

otc-auth cce help

Help about any command

otc-auth cce help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth cce list

Lists Project Clusters in CCE

otc-auth cce list [flags]

Command Flags

  -h, --help            help for list
  -r, --region string   OTC region code. Either provide this argument or set the environment variable REGION

otc-auth completion

To load completions:

Bash:

$ source <(otc-auth completion bash)

# To load completions for each session, execute once:
# Linux:
$ otc-auth completion bash > /etc/bash_completion.d/otc-auth
# macOS:
$ otc-auth completion bash > $(brew --prefix)/etc/bash_completion.d/otc-auth

Zsh:

# If shell completion is not already enabled in your environment,
# you will need to enable it.  You can execute the following once:

$ echo "autoload -U compinit; compinit" >> ~/.zshrc

# To load completions for each session, execute once:
$ otc-auth completion zsh > "${fpath[1]}/_otc-auth"

# You will need to start a new shell for this setup to take effect.

fish:

$ otc-auth completion fish | source

# To load completions for each session, execute once:
$ otc-auth completion fish > ~/.config/fish/completions/otc-auth.fish

PowerShell:

PS> otc-auth completion powershell | Out-String | Invoke-Expression

# To load completions for every new session, run:
PS> otc-auth completion powershell > otc-auth.ps1
# and source this file from your PowerShell profile.

otc-auth completion [bash|zsh|fish|powershell]

Command Flags

  -h, --help   help for completion

otc-auth documentation

Generates markdown documentation

otc-auth documentation [flags]

Command Flags

  -h, --help   help for documentation

otc-auth help

Help about any command

otc-auth help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth login

Login to the Open Telekom Cloud and receive an unscoped token

otc-auth login [flags]

Command Flags

  -h, --help   help for login

otc-auth login help

Help about any command

otc-auth login help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth login iam

Login to the Open Telekom Cloud through its Identity and Access Management system and receive an unscoped token

otc-auth login iam [flags]

Command Flags

  -h, --help                       help for iam
  -d, --os-domain-name string      OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME
  -p, --os-password string         Password for the OTC IAM system. Either provide this argument or set the environment variable OS_PASSWORD
      --os-user-domain-id string   User Id number, can be obtained on the "My Credentials page" on the OTC. Required if --totp is provided.  Either provide this argument or set the environment variable OS_USER_DOMAIN_ID
  -u, --os-username string         Username for the OTC IAM system. Either provide this argument or set the environment variable OS_USERNAME
  -o, --overwrite-token            Overrides .otc-info file
  -r, --region string              OTC region code. Either provide this argument or set the environment variable REGION
  -t, --totp string                6-digit time-based one-time password (TOTP) used for the MFA login flow. Required together with the user-domain-id

otc-auth login idp-oidc

Login to the Open Telekom Cloud through an Identity Provider and OIDC and receive an unscoped token

otc-auth login idp-oidc [flags]

Command Flags

  -c, --client-id string          Client ID as set on the IdP. Either provide this argument or set the environment variable CLIENT_ID
  -s, --client-secret string      Secret ID as set on the IdP. Either provide this argument or set the environment variable CLIENT_SECRET
  -h, --help                      help for idp-oidc
  -i, --idp-name string           Required for authentication with IdP
      --idp-url string            Required for authentication with IdP
      --oidc-scopes stringArray   Flag to set the scopes which are expected from the OIDC request. Either provide this argument or set the environment variable OIDC_SCOPES (default [openid])
  -d, --os-domain-name string     OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME
  -o, --overwrite-token           Overrides .otc-info file
  -r, --region string             OTC region code. Either provide this argument or set the environment variable REGION

otc-auth login idp-saml

Login to the Open Telekom Cloud through an Identity Provider and SAML and receive an unscoped token

otc-auth login idp-saml [flags]

Command Flags

  -h, --help                    help for idp-saml
  -i, --idp-name string         Required for authentication with IdP
      --idp-url string          Required for authentication with IdP
  -d, --os-domain-name string   OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME
  -p, --os-password string      Password for the OTC IAM system. Either provide this argument or set the environment variable OS_PASSWORD
  -u, --os-username string      Username for the OTC IAM system. Either provide this argument or set the environment variable OS_USERNAME
  -o, --overwrite-token         Overrides .otc-info file
  -r, --region string           OTC region code. Either provide this argument or set the environment variable REGION

otc-auth login remove

Removes login information for a cloud

otc-auth login remove [flags]

Command Flags

  -h, --help                    help for remove
  -d, --os-domain-name string   OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME

otc-auth openstack

Manage Openstack Integration

otc-auth openstack [flags]

Command Flags

  -h, --help   help for openstack

otc-auth openstack config-create

Creates new clouds.yaml

otc-auth openstack config-create [flags]

Command Flags

  -l, --config-location string   Where the config should be saved (default "~/.config/openstack/clouds.yaml")
  -h, --help                     help for config-create

otc-auth openstack help

Help about any command

otc-auth openstack help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth projects

Manage Project Information

otc-auth projects [flags]

Command Flags

  -h, --help   help for projects

otc-auth projects help

Help about any command

otc-auth projects help [command] [flags]

Command Flags

  -h, --help   help for help

otc-auth projects list

List Projects in Active Cloud

otc-auth projects list [flags]

Command Flags

  -h, --help   help for list

otc-auth temp-access-token

Manage AK/SK

otc-auth temp-access-token [flags]

Command Flags

  -h, --help                    help for temp-access-token
  -d, --os-domain-name string   OTC domain name. Either provide this argument or set the environment variable OS_DOMAIN_NAME

otc-auth temp-access-token create

Manage temporary AK/SK

otc-auth temp-access-token create [flags]

Command Flags

  -t, --duration-seconds int   The token's lifetime, in seconds. Valid times are between 900 and 86400 seconds (default 900)
  -h, --help                   help for create

otc-auth temp-access-token help

Help about any command

otc-auth temp-access-token help [command] [flags]

Command Flags

  -h, --help   help for help
Clone this wiki locally