CircleCI Server v3.x での Orb の管理

Last updated
Tags Server v3.x サーバー管理者

ここでは Server v3.x. で Orb を管理する方法を説明します。 CircleCI Server システムには、固有のローカル Orb レジストリが含まれています。 設定ファイルで参照された Orb はすべて、この CircleCI Server Orb レジストリに含まれる Orb を参照します。 Orb のメンテナンスはご自身で行う必要があります。 具体的には、パブリックレジストリからの Orb のコピー、以前コピーした Orb の更新、会社のプライベート Orb の登録 (存在する場合) を行います。

Orb と 関連するユースケースについては、 Orb に関するドキュメント を参照してください。

Orb の作成に関する情報は、 Orb オーサリングの概要 を参照してください。

Orb の管理

Orb には、 CircleCI CLI からアクセスします。 Orb を使用するには、管理者である必要があります。 また、 パーソナル API トークンが必要です。

必ずユーザーアカウントが管理者になった_後で_生成されたパーソナル API トークンを使用してください。

--host オプションを使用してローカルリポジトリの場所を指定することで、パブリッククラウドの Orb ではなくローカルサーバーの Orb にアクセスできます。 For example, if your server installation is located at http://circleci.somehostname.com, you can run orb commands local to that orb repository by passing --host http://cirlceci.somehostname.com.

利用可能な Orb の一覧

利用可能なパブリック Orb のリストを表示するには、Orb ディレクトリにアクセスするか、以下のコマンドを実行します。

circleci orb list

(ローカルの CircleCI Server Orb リポジトリに登録された) 利用可能なプライベート Orb のリストを表示するには、次のコマンドを実行します。

circleci orb list --host <your-server-install-domain> --token <your-api-token>

パブリック Orb のインポート

パブリック Orb をローカルサーバーの Orb リポジトリにインポートするには、次のコマンドを実行します。

circleci admin import-orb <namespace>[<orb-name>[@<orb-version>]] --host <your-server-installation-domain> --token <your-api-token>
名前空間の指定のみを行うよう選択することも可能です。この場合、名前空間にあるすべての Orb の最新バージョンがインポートされます。

パブリック Orb の更新のフェッチ

ローカルの CircleCI Server Orb リポジトリに存在するパブリック Orb を新しいバージョンに更新するには、以下のコマンドを実行します。

circleci admin import-orb ns[orb[@version]] --host <your server installation domain> --token <your api token>

プロキシ内での Orb の使用

Orb をインポートする際は、CLI が CircleCI Server や circleci.com と通信できる状態にある必要があります。 プロキシ内でサーバー環境を使用した状態で行う場合は、サーバーにリクエストをプロキシするのではなく、プロキシを使って`circleci.com`にリクエストを行うように CLI を設定する必要があります。 例えば下記のようにします。

export NO_PROXY=server.example.com
export HTTPS_PROXY=http://proxy.example.com:3128
export HTTP_PROXY=http://proxy.example.com:3128
circleci admin import-orb ns[orb[@version]] --host <your server installation domain> --token <your api token>


ドキュメントの改善にご協力ください

このガイドは、CircleCI の他のドキュメントと同様にオープンソースであり、GitHub でご利用いただけます。 ご協力いただき、ありがとうございます。

サポートが必要ですか?

CircleCI のサポートエンジニアによる、サービスに関する問題、請求およびアカウントについての質問への対応、設定の構築に関する問題解決のサポートを行っています。 サポートチケットを送信して、CircleCI のサポートエンジニアにお問い合わせください。日本語でお問い合わせいただけます。

または、サポートサイトから、サポート記事やコミュニティフォーラム、トレーニングリソースをご覧いただけます。