OpenStackClient 매뉴얼 페이지

1 개요

openstack

OpenStack 커맨드 라인

OpenStackClient 매뉴얼 페이지

https://docs.openstack.org/python-openstackclient/2024.1/cli/man/openstack.html

2 SYNOPSIS

openstack [<global-options>] <command> [<command-arguments>]

openstack help <command>

openstack --help

3 설명

openstack은 오픈스택 API에 공통 명령줄 인터페이스를 제공합니다. 이는 오픈스택 프로젝트 클라이언트 라이브러리에서 제공하는 CLI와 거의 동일하지만, 독특하고 일관된 명령어 구조를 가지고 있습니다.

4 인증 방법

openstack은 OpenStack 프로젝트 CLI와 유사한 인증 체계를 사용하며, 자격증명 정보는 환경변수나 명령줄 옵션으로 제공됩니다. 주요 차이점은 옵션 이름에 'project'가 포함되어 OS_PROJECT_NAME/OS_PROJECT_ID로 제공된다는 점입니다(이전의 테넌트 기반 이름 대신).

export OS_AUTH_URL=<url-to-openstack-identity>
export OS_PROJECT_NAME=<project-name>
export OS_USERNAME=<user-name>
export OS_PASSWORD=<password>  # (optional)

openstack은 keystoneclient 라이브러리가 제공하는 다양한 유형의 인증 플러그인을 사용할 수 있습니다. 기본적으로 사용할 수 있는 플러그인은 다음과 같습니다:

• token: 토큰을 사용한 인증
• password: 사용자명과 패스워드를 사용한 인증
• openid: OpenID Connect 프로토콜을 사용한 인증

이 플러그인과 그 옵션에 대한 자세한 내용과 사용가능한 플러그인의 전체 목록은 keystoneclient 라이브러리 문서를 참조하십시오. 일부 플러그인은 openstack의 모든 기능을 지원하지 않을 수 있습니다. 예를 들어, v3unscopedsaml 플러그인은 범위가 지정되지 않은 토큰만 제공할 수 있으며, 이 인증 방법으로는 일부 명령을 사용할 수 없습니다.

또한, Keystone의 서비스 토큰을 사용하여 인증할 수도 있습니다. 이 경우, --os-token과 --os-endpoint 옵션(또는 환경변수 OS_TOKEN과 OS_ENDPOINT)을 설정해야 합니다. 이 방법은 인증 플러그인보다 우선합니다.

Note

v3unscopedsaml 방법을 사용하려면 lxml 패키지를 설치해야 합니다.

4.1 페더레이션을 사용한 인증

페더레이션 인증을 사용하려면, 설정 파일에 다음이 필요합니다:

export OS_PROJECT_NAME=<project-name>
export OS_PROJECT_DOMAIN_NAME=<project-domain-name>
export OS_AUTH_URL=<url-to-openstack-identity>
export OS_IDENTITY_API_VERSION=3
export OS_AUTH_PLUGIN=openid
export OS_AUTH_TYPE=v3oidcpassword
export OS_USERNAME=<username-in-idp>
export OS_PASSWORD=<password-in-idp>
export OS_IDENTITY_PROVIDER=<the-desired-idp>
export OS_CLIENT_ID=<the-client-id-configured-in-the-idp>
export OS_CLIENT_SECRET=<the-client-secred-configured-in-the-idp>
export OS_OPENID_SCOPE=<the-scopes-of-desired-attributes-to-claim-from-idp>
export OS_PROTOCOL=<the-protocol-used-in-the-apache2-oidc-proxy>
export OS_ACCESS_TOKEN_TYPE=<the-access-token-type-used-by-your-idp>
export OS_DISCOVERY_ENDPOINT=<the-well-known-endpoint-of-the-idp>
export OS_ACCESS_TOKEN_ENDPOINT=<the-idp-access-token-url>