otc-cli

OTC CLI

A command-line interface tool for Open Telekom Cloud (OTC) that provides seamless authentication and resource management with federated Single Sign-On (SSO) support.

Features

• 🔐 Federated Authentication - Login via OIDC/Keycloak SSO or IAM credentials
• ⚡ Temporary Credentials - Generate 24-hour AWS-compatible credentials
• 🔄 Token Caching - Automatic token management and refresh
• 📦 Resource Management - List and manage OTC resources
• 🌐 Multi-Project Support - Work with multiple OTC projects
• 🚀 CCE Integration - Get kubeconfig for Kubernetes clusters

Installation

From Source

git clone https://github.com/abdo-farag/otc-cli.git
cd otc-cli
go build -o otc-cli cmd/otc-cli/main.go
sudo mv otc-cli /usr/local/bin/

Using Go Install

go install github.com/abdo-farag/otc-cli@latest

Quick Start

Option 1: Login with Federated SSO (OIDC/Keycloak)

1. Configure environment variables:

# OIDC/Keycloak Configuration
export IDP_URL="https://your-keycloak.com/realms/YourRealm"
export IDP_CLIENT_ID="otc-client"
export IDP_CLIENT_SECRET="your-client-secret"  # Optional, for confidential clients
export IDP_PROVIDER_NAME="YourSSO"

# OTC Configuration
export OS_DOMAIN_NAME="OTC00000000001000001234"
export OS_REGION="eu-de"

1. Login:

otc-cli login

This will open your browser for SSO authentication. After successful login, credentials are saved to otc-credentials.sh.

1. Load credentials:

source otc-credentials.sh

Option 2: Login with IAM Credentials

1. Configure environment variables:

export OS_USERNAME="your-username"
export OS_PASSWORD="your-password"
export OS_DOMAIN_NAME="OTC00000000001000001234"
export OS_REGION="eu-de"

1. Login:

otc-cli login --iam

1. Load credentials:

source otc-credentials.sh

Basic Usage

List Resources

# List all projects
otc-cli list projects

# List servers/instances
otc-cli list servers

# List servers in specific project
otc-cli list servers -p "Production"

# List VPCs
otc-cli list vpcs

# List subnets
otc-cli list subnets

# List volumes
otc-cli list volumes

# List CCE clusters
otc-cli list cce

Get Kubeconfig

# Get kubeconfig for CCE cluster
otc-cli get kubeconfig -c cluster-name

# Save to specific file
otc-cli get kubeconfig -c cluster-id -o ~/.kube/otc-config

Logout

Clear cached credentials:

otc-cli logout

Configuration

Keycloak OIDC Client Setup

If using federated SSO, configure your Keycloak client:

1. Create OIDC Client in Keycloak Admin Console
2. Client Settings:
   • Client Protocol: openid-connect
   • Access Type: public or confidential
   • Valid Redirect URIs: http://localhost:9197/oidc/auth
   • Web Origins: http://localhost:9197
3. Required Scopes: openid, email, profile, roles, groups, offline_access

Environment Variables

Documentation

For advanced usage, detailed examples, and troubleshooting, see the complete documentation.

Topics covered in the advanced docs:

• Working with multiple projects
• JSON output and scripting
• Integration with AWS CLI, Terraform, and boto3
• Detailed troubleshooting guide
• Authentication flow diagrams
• CI/CD integration

Quick Troubleshooting

"Could not find OIDC configuration" error

• Verify IDP_PROVIDER_NAME matches the Identity Provider name in OTC IAM
• Check that federated identity is properly configured in OTC Console

"Project not found" error

List available projects first:

otc-cli list projects

Browser doesn't open

Use no-browser mode:

otc-cli login --no-browser

For more detailed troubleshooting, see otc-cli.md.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

MIT License - see LICENSE file for details

Links

• Documentation: otc-cli.md
• Issues: GitHub Issues
• Repository: github.com/abdo-farag/otc-cli

Related Documentation

• Keycloak Documentation: https://www.keycloak.org/documentation
  • OIDC Client Configuration
  • Identity Brokering
• Open Telekom Cloud Documentation: https://docs.otc.t-systems.com/
  • Identity and Access Management (IAM)
  • IAM Federated Identity Authentication
  • API Reference
• Gopher Telekom Cloud SDK: https://github.com/opentelekomcloud/gophertelekomcloud
  • Go SDK for Open Telekom Cloud (this project uses it internally)

Note: This is an unofficial tool and is not supported by T-Systems or Deutsche Telekom.