非推奨

これらのモジュールは、Ansible 2.5 に追加された k8s_raw と openshift_raw モジュールに置き換えられました。

ansible-kubernetes-modules

最新の K8s モジュールにアクセスできます。

この役割をプレイブックに含めると、ほかのプレイ、役割、およびインクルードがモジュールにアクセスできます。

モジュールは library フォルダ にあります。各モジュールにはパラメータと返されるデータ構造の完全なドキュメントがあります。ただし、すべてのモジュールに例が含まれているわけではなく、テストデータ が作成されたものだけに例があります。

特定のモジュールに問題がある場合や提案がある場合は、OpenShift Rest Client リポジトリ に問題を報告してください。

利便性のために、k8s_common.py および openshift_common.py モジュールが module_utils に含まれています。これは現在公式の Ansible リリースには含まれていませんが、Ansible の一部で、devel ブランチにあります。そのため、バグを見つけたり変更を加えたりしたい場合は、Ansible リポジトリ に問題を開き、プルリクエストを提出してください。

要件

• Ansible
• モジュールを実行するホストにインストールされた OpenShift Rest Client

インストールと使用方法

Galaxy クライアントを使用して役割をインストールします：

$ ansible-galaxy install ansible.kubernetes-modules

インストール後、プレイブックに追加します：

---
- hosts: localhost
  remote_user: root
  roles:
    - role: ansible.kubernetes-modules
      install_python_requirements: no
    - role: hello-world

役割が参照されているため、hello-world 役割は K8s モジュールを使用してアプリケーションをデプロイできます。実際の役割の内容を確認するには、tests/roles フォルダを確認してください。

API との認証

モジュールは Kubernetes または OpenShift API と直接インタラクトします。kubectl または oc CLI ツールがインストールされている必要はありません。

モジュールパラメータ

OpenShift Rest Client は Kubernetes の設定ファイルを必要とします。以下のオプションを使用して、ファイルの場所やAPIとの認証に使用するコンテキストを制御します：

kubeconfig

設定ファイルのデフォルトパスは ~/.kube/config です。代替ファイルパスを渡すために使用します。

context

認証に使用する設定コンテキストの名前。指定しない場合は、現在アクティブなコンテキストが使用されます。

設定ファイルに見つかった設定を上書きするためのパラメータを使用します：

host

API サーバーへの URL を提供します。

ssl_ca_cert

証明書機関証明書ファイルのパス。

cert_file

サーバー証明書ファイルのパス。

key_file

秘密鍵ファイルのパス。

api_key

API トークン。

verify_ssl

true または false を設定します。falseの場合、SSL 検証は強制されません。

環境変数

個々のモジュールに認証設定をパラメータとして渡すのではなく、環境変数を使用して情報を渡すことができます。環境変数の名前は K8S_AUTH_ に続いて大文字の変数名です。たとえば、key_file は K8S_AUTH_KEY_FILE になります。

役割の変数

install_python_requirements

OpenShift Rest Client をインストールしたい場合は true に設定します。デフォルトは false です。pip でインストールされます。

virtualenv

pip パッケージをインストールする際に使用する仮想環境の名前を提供します。

ライセンス

Apache V2