mcpField
C
Cloud Foundry CLI

Cloud Foundry CLI

公式
docs.cloudfoundry.orgクラウド・DevOps1.9kcf6 日前に更新
リポジトリ公式サイト

Cloud Foundry CLI について

Cloud Foundry CLI は Cloud Foundry プラットフォーム公式ツールで、アプリケーションデプロイとプラットフォーム管理に使用します。ワンコマンドアプリケーション push、サービスバインディング、ルート管理、組織・スペース管理に対応しています。

主な機能

  1. 01cf push でアプリケーションを Cloud Foundry に素早くデプロイ
  2. 02マーケットプレイスからサービスを選択してバインド（データベース、メッセージキュー等）
  3. 03アプリケーションルート、ドメイン、トラフィックルーティングを管理
  4. 04組織、スペース、開発者権限を作成・管理

活用シーン

  1. 01Cloud Foundry プラットフォームにアプリケーションを迅速にデプロイ・更新
  2. 02CI/CD ワークフローでアプリケーションデプロイを自動化
  3. 03アプリケーション依存サービスを管理し実行環境を設定

インストール

OS またはパッケージマネージャーを選び、コマンドをターミナルで実行します。

$
brew install cloudfoundry/tap/cf-cli@8

インストール後にcf --versionを実行して確認します。

コマンド例

よく使うコマンドを使う順に並べています。

01
cf login
02
cf push
03
cf apps

詳細

CF ロゴ

Cloud Foundry CLI

Cloud Foundry の公式コマンドラインクライアントです。

v8 CLI または v7 CLI の最新のヘルプを確認するか、cf help -a を実行して、現在インストールされているバージョンで利用可能なすべてのコマンドのヘルプを表示してください。

GitHub version Documentation Command help pages Slack License

CF CLI バイナリのダウンロードサーバーの稼働状況：

Downloads Uptime

セクション： はじめに | ダウンロード | 既知の問題 | バグ／機能リクエスト | プラグイン開発 | 貢献

はじめに

ダウンロードセクションから v8 cf CLI をダウンロードしてインストールしてください。

インストール後、ログインしてアプリをプッシュできます。 現在サポートされている cf CLI のバージョン：

  1. v8 cf CLI は、プラグインを除き、v3 CC API に対応しています。詳しくは、v8 のドキュメントをご覧ください。

注：v7 および v6 CLI のバージョンは、すでにメンテナンスもリリースも行われていません。

CLI v7 および v8 のバージョニングとサポートポリシーのドキュメントをご覧ください。

ご質問がある場合は、Slack コミュニティの #cli チャンネル、cf-dev メーリングリストでお気軽にお尋ねください。または、GitHub issue を作成してください。

貢献とビルド手順

貢献者向けガイドをお読みください。

翻訳の更新を投稿する場合は、投稿方法についてi18n READMEをご覧ください。

例

CLI の利用体験をさらに向上させるには、コミュニティが提供する CLI プラグインをご確認ください。

ダウンロード

インストール手順

既知の問題

注： 問題や回避策に関する最新情報については、未解決および解決済みの GitHub の問題をご確認ください。

  • Windows の Cygwin と Git Bash では、対話形式のパスワードプロンプト（cf login 内）がパスワードを stdout から適切に隠せません（issue #1835）。回避策として、別のコマンド（cf login の代わりに、対話形式ではない認証の cf auth）を使用してください。または、Windows の cmd コマンドラインを使用してください。
  • Windows では、TERM が設定されていないと cf ssh が正しく表示されない場合があります。TERM を msys に設定すると、こうした問題の一部が解決することがわかっています。
  • Windows では、MINGW32 または MINGW64 シェルから cf ssh を実行するとハングします。回避策として、代わりに PowerShell を使用してください。
  • CF CLI／GoLang は OpenSSL を使用しません。--skip-ssl-validation を指定せずに login／auth を行うには、カスタム証明書／自己署名証明書を特定の場所にインストールする必要があります。
  • ターミナルへの API トレース出力（CF_TRACE=true、-v オプション、または cf config --trace を使用）は、一部の CLI プラグインコマンドでは正常に動作しません。ファイルへのトレース出力は問題なく動作します。Linux では、CF_TRACE=/dev/stdout も使用できます。詳しくは、Diego-Enabler プラグインの issueをご覧ください。
  • cf push で使用する .cfignore は、CLI が正しく解釈できるよう UTF-8 エンコーディングである必要があります。（issue #281）
  • Linux で「bash: .cf: No such file or directory」というメッセージが表示される場合は、アーキテクチャに適したバイナリまたはインストーラーを使用していることを確認してください。
  • X-Cf-Warnings は stdout に出力されます。これが不都合な場合は CF_RAISE_ERROR_ON_WARNINGS を設定してください。その場合、警告は stderr に出力されます。X-Cf-Warnings が stdout に出力される issueをご覧ください。
  • ユーザーによる組織作成時に、誤った失敗メッセージが表示されます。CLI v7.0 および CLI v7.1 では、user-org-creation 機能フラグが有効な非管理者ユーザーが cf create-org を実行すると、失敗が発生します。このコマンドは、ユーザーに org-manager ロールを付与しようとして明示的に失敗します。しかし、CAPI によってユーザーに org-manager ロールが付与され、その組織にアクセスできるため、実際には作成に成功しています。この問題は CLI v7.2 で解決されています。新しい組織の作成とロールの割り当てに関する v2／v3 の動作の不一致をご覧ください。

問題と機能リクエストの報告

まず、最新の cliに更新して、 もう一度コマンドを実行してください。

エラーが解消しない場合、または機能がまだ実装されていない場合は、未解決の問題を確認し、まだ報告されていなければ、必要な詳細を記載して新しい issue を報告してください。

プラグイン開発

CF CLI は、プラグイン API を介した外部コードの実行をサポートしています。詳しくは、以下をご覧ください。

プラグインコードをインポートする際は、import "code.cloudfoundry.org/cli/v9/plugin" を使用してください。 github.com/cloudfoundry/cli/plugin をインポートする古いプラグインも、 plugins ディレクトリをベンダリングしていれば引き続き動作します。

コメント

Markdown 対応