スタートガイド

ここでは、CDK と必要な依存関係をインストールする方法を説明します。

個人システムに CDK を設定する基本的な手順は次のとおりです。

設定手順は、仮想マシンの起動権限を持つ通常のユーザーとして実行する必要があります。この手順では、そのパーミッションを割り当てる方法と、ハイパーバイザーおよびコマンドシェルを設定して CDK を起動し、効果的に対話する方法を説明します。

CDK では、OpenShift クラスターがプロビジョニングされる仮想マシンを起動するハイパーバイザーが必要です。CDK を設定する前に、選択したハイパーバイザーがシステムにインストールされ、有効になっていることを確認します。ハイパーバイザーを起動して実行したら、CDK がそのハイパーバイザーと連携するには、追加の設定が必要になります。

ホストオペレーティングシステムによっては、以下の推奨されるネイティブハイパーバイザーを選択できます。

その実行に必要なハードウェアおよびオペレーティングシステムのバージョンを確認するには、各ハイパーバイザーのドキュメント を参照してください。

特定のオペレーティングシステムのハイパーバイザーを設定するには、適切な手順に従ってください。CDK は、libmachine とそのドライバープラグインアーキテクチャーを使用して、CDK 仮想マシンを管理する一貫した方法を提供します。

ハイパーバイザーによっては、ドライバープラグインを手動でインストールする必要があります。CDK は VirtualBox ドライバープラグインを組み込むため、設定する追加の手順は必要ありません。ただし、--vm-driver virtualbox フラグまたは永続設定を使用して、VirtualBox を CDK に識別する必要があります。詳細は、「VirtualBox を使用するように CDK を設定」を参照してください。

お使いのハイパーバイザーおよびオペレーティングシステムに適したセクションを参照してください。

組み込みの VirtualBox ドライバーを使用するには、VirtualBox を手動でインストールする必要があります。VirtualBox バージョン 5.1.12 以降が必要です。埋め込みドライバーを使用する前に、必ず VirtualBox をダウンロードし、インストール してください。

--vm-driver virtualbox フラグまたは永続設定オプションを使用して、VirtualBox を CDK に識別する必要があります。

$ minishift start --vm-driver virtualbox

$ minishift config set vm-driver virtualbox

このセクションでは、CDK とプロビジョニングされた OpenShift クラスターの簡単なデモについて説明します。CDK の使用に関する詳細は、「基本的な使用方法」セクションを参照してください。

OpenShift との対話は、ホストにコピーされるコマンドラインツールの oc を使用しています。CDK がローカル OpenShift インスタンスとの対話および設定を支援する方法の詳細は、「OpenShift クライアントバイナリー」を参照してください。

OpenShift クラスターアーキテクチャーについての詳細は、OpenShift ドキュメントの「アーキテクチャーの概要」を参照してください。

以下の手順では、KVM ハイパーバイザードライバーを使用して、Linux オペレーティングシステムの CDK を使い始める方法を説明します。

minishift setup-cdk コマンドは、システムで CDK を実行するために必要なコンポーネントを取得して設定します。デフォルトでは、minishift setup-cdk は CDK コンテンツを ~/.minishift ディレクトリーに格納します (Windows では %USERPROFILE%/.minishift)。

以下のコマンドを実行して、Red Hat Enterprise Linux の CDK を設定します。

$ minishift setup-cdk
Setting up CDK 3 on host using '/home/user/.minishift' as Minishift's home directory
Copying minishift-rhel7.iso to '/home/user/.minishift/cache/iso/minishift-rhel7.iso'
Copying oc to '/home/user/.minishift/cache/oc/v3.10.45/linux/oc'
Creating configuration file '/home/user/.minishift/config/config.json'
Creating marker file '/home/user/.minishift/cdk'
Default add-ons anyuid, admin-user, xpaas, registry-route, che, eap-cd installed
Default add-ons anyuid, admin-user, xpaas enabled
CDK 3 setup complete.

Windows または macOS の場合: Windows と macOS で minishift setup-cdk コマンドを実行すると、異なるコンポーネントおよびパス名に基づいて、出力が若干異なります。

コマンドラインインターフェースおよび Web コンソールで OpenShift と対話する方法は、「OpenShift クライアントバイナリー」セクションを参照してください。

OpenShift は、テンプレート、ビルダーアプリケーション、クイックスタートなどのさまざまなサンプルアプリケーションを提供します。以下の手順では、コマンドラインから Node.js アプリケーションのサンプルをデプロイする方法を説明します。

OpenShift でのアプリケーションの作成に関する詳細は、OpenShift ドキュメントの「新規アプリケーションの作成」を参照してください。

このセクションでは、minishift バイナリーをアンインストールし、関連するファイルを削除する方法を説明します。

CDK を使用する場合は、以下のコンポーネントと対話します。

CDK アーキテクチャー の図では、これらのコンポーネントについて説明します。簡単な実行のために PATH に配置される minishift バイナリーは、CDK 仮想マシンを 起動、停止、および 削除 するために使用されます。仮想マシン自体は、Red Hat Enterprise Linux Live ISO からブートストラップされます。

docker-env などの一部の CDK コマンドは Docker デーモンと対話し、他のものも OpenShift クラスター (openshift コマンドなど) と通信します。

OpenShift クラスターが稼働したら、oc バイナリーを使用して対話します。(デフォルトの ~/.minishift ごとに) CDK はこのバイナリーを $MINISHIFT_HOME でキャッシュします。minishift oc-env は、oc バイナリーを PATH に追加する簡単な方法です。

CDK を使用したローカル OpenShift クラスターの管理に関する詳細は、3章Container Development Kit を使用した OpenShift との対話 を参照してください。

図2.1 : CDK アーキテクチャー

CDK のランタイム動作は、フラグ、環境変数、および永続的な設定オプションで制御できます。

CDK の動作を制御するには、以下の優先順位が適用されます。以下のリストの各アクションは、その下のアクションよりも優先されます。

$ minishift setup-cdk --minishift-home ~/.mynewdir
$ export MINISHIFT_HOME=~/.mynewdir
$ echo 'export MINISHIFT_HOME=~/.mynewdir' >> ~/.bashrc

# Set default memory 4096 MB
$ minishift config set memory 4096

$ minishift config set --global memory 8192

$ minishift start --insecure-registry hub.foo.com --insecure-registry hub.bar.com

$ minishift config set insecure-registry hub.foo.com,hub.bar.com

$ minishift config view
- memory: 4096

$ minishift config view --global
- memory: 8192

$ minishift config get memory
4096

$ minishift config unset memory

OpenShift クラスターのプロビジョニングの一環として、OpenShift クラスター用に 100 個の 永続ボリューム が作成されます。これにより、アプリケーションは 永続ボリューム要求 を作成できます。永続データの場所は、minishift start コマンドの host-pv-dir フラグで決定し、デフォルトでは CDK 仮想マシンの /var/lib/minishift/openshift.local.pv に設定されます。

HTTP/HTTPS プロキシーの背後にある場合は、Docker および OpenShift が適切に動作するようにプロキシーオプションを指定する必要があります。これには、minishift start 時に必要なフラグを渡します。

以下に例を示します。

$ minishift start --http-proxy http://YOURPROXY:PORT --https-proxy https://YOURPROXY:PORT

認証されたプロキシー環境では、proxy_user および proxy_password はプロキシー URI の一部である必要があります。

 $ minishift start --http-proxy http://<proxy_username>:<proxy_password>@YOURPROXY:PORT \
                   --https-proxy https://<proxy_username>:<proxy_password>@YOURPROXY:PORT

--no-proxy フラグを使用して、プロキシーを設定するべきでないホストをコンマ区切りリストで指定することもできます。

プロキシーオプションを使用すると、Docker デーモンと、指定されたプロキシーを使用するように OpenShift を透過的に設定します。

CDK 仮想マシンは、ホストのみの IP アドレスでホストシステムに公開されます。これは、minishift ip コマンドで取得できます。

minishift ssh コマンドを使用して、CDK 仮想マシンと対話できます。

サブコマンドを使用せずに minishift ssh を実行して対話式シェルを開き、SSH を使用して任意のリモートマシンでコマンドを実行するのと同じ方法で CDK 仮想マシンでコマンドを実行できます。

サブコマンドで minishift ssh を実行して、サブコマンドを CDK 仮想マシンに直接送信し、結果をローカルシェルに戻すこともできます。以下に例を示します。

$ minishift ssh -- docker ps
CONTAINER    IMAGE                   COMMAND                CREATED        STATUS        NAMES
71fe8ff16548 openshift3/ose:v3.11.374 "/usr/bin/openshift s" 4 minutes ago  Up 4 minutes  origin

プロファイルは、Minishift 仮想マシンのインスタンスと、そのすべての設定と状態です。プロファイル機能により、これらの分離された Minishift インスタンスを作成および管理できます。

各 CDK プロファイルは、独自の設定 (メモリー、CPU、ディスクサイズ、アドオンなど) で作成され、他のプロファイルには依存しません。cpus、memory などの特定の設定が確実にすべてのプロファイルに適用されるようにするには、「環境変数の使用」を参照してください。

active プロファイルは、グローバル --profile フラグが使用されていない限り、すべてのコマンドが実行されるプロファイルです。minishift profile list コマンドを使用して、アクティブなプロファイルを確認できます。--profile フラグを使用すると、アクティブでないプロファイルに対して単一のコマンドを実行できます。たとえば、minishift --profile profile-demo console コンソールは、指定された profile-demo プロファイルの OpenShift コンソールを開きます。

--profile フラグには、アクティブなプロファイルを一覧表示、削除、および設定するためのコマンドがあります。これらのコマンドは、以下のセクションで説明します。

新しいプロファイルを作成する方法は 2 つあります。

$ minishift --profile profile-demo start
-- Starting profile 'profile-demo'
-- Check if deprecated options are used ... OK
-- Checking if https://github.com is reachable ... OK
-- Checking if requested OpenShift version 'v3.11.0' is valid ... OK
-- Checking if requested OpenShift version 'v3.11.0' is supported ... OK
-- Checking if requested hypervisor 'hyperkit' is supported on this platform ... OK
-- Checking if hyperkit driver is installed ...
   Driver is available at /usr/local/bin/docker-machine-driver-hyperkit
   Checking for setuid bit ... OK
-- Checking the ISO URL ... OK
-- Checking if provided oc flags are supported ... OK
-- Starting the OpenShift cluster using 'hyperkit' hypervisor ...
-- Minishift VM will be configured with ...
   Memory:    4 GB
   vCPUs :    2
   Disk size: 20 GB
-- Starting Minishift VM .....

$ minishift profile set demo
Profile 'demo' set as active profile

minishift profile list コマンドを使用して、既存プロファイルの一覧を表示できます。出力にアクティブなプロファイルが強調表示されているようにすることもできます。

$ minishift profile list
- minishift     Running     	(Active)
- profile-demo  Does Not Exist

プロファイルを切り替えるには、minishift profile set コマンドを使用します。

$ minishift profile set profile-demo
Profile 'profile-demo' set as active profile

プロファイルを削除するには、以下を実行します。

$ minishift profile delete profile-demo
You are deleting the active profile. It will remove the VM and all related artifacts. Do you want to continue [y/N]?: y
Deleted:  /Users/user/.minishift/profiles/profile-demo
Profile 'profile-demo' deleted successfully
Switching to default profile 'minishift' as the active profile.

新しいプロファイルを作成し、その 永続的な設定 を行うには、2 つのオプションがあります。最初のオプションは、profile set コマンドを使用して、アクティブプロファイルを作成して、新しいプロファイルを暗黙的に作成することです。プロファイルがアクティブになったら、minishift config コマンドを実行します。最後に、インスタンスを起動します。

$ minishift profile set profile-demo
$ minishift config set memory 8GB
$ minishift config set cpus 4
$ minishift addon enable anyuid
$ minishift start

または、--profile フラグを使用して、ターゲットプロファイルを明示的に指定する一連のコマンドを実行することです。

$ minishift --profile profile-demo config set memory 8GB
$ minishift --profile profile-demo config set cpus 4
$ minishift --profile profile-demo addon enable anyuid
$ minishift --profile profile-demo start

OpenShift クラスターのプロビジョニングを迅速化し、ネットワークトラフィックを最小限に抑えるために、コンテナーイメージをホストにキャッシュすることができます。これらのイメージは、要求に応じて明示的に、または minishift start の時に暗黙的に、実行中の Docker デーモンにインポートできます。以下のセクションでは、イメージのキャッシュとその設定について詳しく説明します。

$ minishift delete --clear-cache

CDK は、イメージキャッシュの動作を制御するために、image コマンドとサブコマンドを提供します。CDK 仮想マシンの Docker デーモンからイメージをエクスポートしてインポートするには、minishift image export と minishift image import を使用します。

$ minishift image export <image-name-0> <image-name-1> ...
Pulling image <image-name-0> .. OK
Exporting <image-name-0>. OK
Pulling image <image-name-1> .. OK
Exporting <image-name-2>. OK

$ minishift image import <image-name-0> <image-name-1> ...
Importing <image-name-0> . OK

$ minishift image list
registry.access.redhat.com/openshift3/ose-docker-registry:v3.11.374
registry.access.redhat.com/openshift3/ose-haproxy-router:v3.11.374
registry.access.redhat.com/openshift3/ose:v3.11.374

$ minishift image list --vm
registry.access.redhat.com/openshift3/ose-deployer:v3.11.374
registry.access.redhat.com/openshift3/ose-docker-registry:v3.11.374
registry.access.redhat.com/openshift3/ose-haproxy-router:v3.11.374
registry.access.redhat.com/openshift3/ose-pod:v3.11.374
registry.access.redhat.com/openshift3/ose-web-console:v3.11.374
registry.access.redhat.com/openshift3/ose:v3.11.374

$ minishift image cache-config view
$ minishift image cache-config add alpine:latest busybox:latest
$ minishift image cache-config view
alpine:latest
busybox:latest

$ minishift image cache-config remove alpine:latest
$ minishift image cache-config view
busybox:latest

CDK では、イメージのキャッシュがデフォルトで有効になっています。これは、minishift start コマンドを初めて完了した後にバックグラウンドプロセスで発生します。イメージが $MINISHIFT_HOME/cache/image にキャッシュされると、連続した CDK 仮想マシンの作成により、これらのキャッシュされたイメージが使用されます。

この機能を無効にするには、minishift config set コマンドを使用して、永続設定で image-caching プロパティーを無効にする必要があります。

$ minishift config set image-caching false

image-caching を true に設定するか、minishift config unset を使用して設定をすべて削除して、OpenShift イメージのキャッシュを再度有効にできます。

$ minishift config unset image-caching

イメージは $MINISHIFT_HOME/cache/images の下にキャッシュされ、SHA256 ブロブとして、イメージ名で SHA を照合する際の詳細情報が含まれるインデックスとして保存されます。

ローカルキャッシュからイメージを削除するには、minishift image delete コマンドを使用します。

$ minishift image delete <image-name-0> <image-name-1> ...
Deleting <image-name-0> from the local cache OK
Deleting <image-name-1> from the local cache OK

CDK を使用すると、cluster up により提供される vanilla OpenShift 設定をアドオンメカニズムで拡張できます。

アドオンは、.addon 拡張子が付いたテキストファイルを含むディレクトリーです。このディレクトリーには、JSON テンプレートファイルなどの他のリソースファイルを含めることもできます。ただし、アドオンごとに 1 つの .addon ファイルのみが許可されます。

以下の例は、アドオンの名前と説明、追加のメタデータ、および適用する実際のアドオンコマンドなど、アドオンファイルの内容を示しています。

# Name: anyuid                                                                          1
# Description: Allows authenticated users to run images under a non pre-allocated UID   2
# Required-Vars: ACME_TOKEN                                                             3
# OpenShift-Version: >3.6.0                                                             4
# Minishift-Version: >1.22.0                                                            5

mytoken := oc sa get-token oauth-client                                                 6

oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}                                  7
oc adm policy add-scc-to-group anyuid system:authenticated                              8

有効なアドオンは、初期クラスタープロビジョニングが正常に完了した直後に、minishift start 時に適用されます。

アドオンメタデータの一部として、アドオンを適用するために実行中の OpenShift バージョンを指定できます。これを実行するには、任意の OpenShift-Version メタデータフィールドを指定できます。セマンティクスは以下のとおりです。

アドオンメタデータの一部として、アドオンを適用するために実行する必要のある Minishift バージョンを指定できます。これを行うには、オプションの Minishift-Version メタデータフィールドを指定できます。セマンティクスは以下のとおりです。

アドオン依存関係は、Depends-On メタデータフィールドを使用して定義できます。複数の依存関係は、アドオン名のコンマ区切りリストを使用して定義できます。

# Name: example
# Description: Shows the use of the Depends-On metadata field
# Depends-On: anyuid, admin-user

echo Depends on the anyuid and admin-user add-ons, requiring them to be installed.

本セクションでは、アドオンファイルに追加できるコマンドを説明します。CDK アドオンのドメイン固有の小さな言語を形成します。

CDK では、アドオンコマンド内で変数を使用できます。変数の形式は #{<variable-name>} です。以下の例は、OpenShift ルーティング接尾辞が openshift コマンドに挿入され、OpenShift レジストリーのセキュリティー保護の一環として新規証明書を作成する方法を示しています。使用された変数 #{routing-suffix} は組み込みアドオン変数の一部です。

$ openshift admin ca create-server-cert \
  --signer-cert=/var/lib/origin/openshift.local.config/master/ca.crt \
  --signer-key=/var/lib/origin/openshift.local.config/master/ca.key \
  --signer-serial=/var/lib/origin/openshift.local.config/master/ca.serial.txt \
  --hostnames='docker-registry-default.#{routing-suffix},docker-registry.default.svc.cluster.local,172.30.1.1' \
  --cert=/etc/secrets/registry.crt \
  --key=/etc/secrets/registry.key

$ minishift addons apply --addon-env PROJECT_USER=user acme

$ minishift config set addon-env PROJECT_USER=user
$ minishift addons apply acme

$ minishift config set addon-env PROJECT_USER=env.USER        1
$ minishift addons apply acme                                 2

# Name: acme
# Description: ACME add-on
# Required-Vars: PROJECT_USER

# Name: acme
# Description: ACME add-on
# Required-Vars: PROJECT_USER
# Var-Defaults: PROJECT_USER=user

mytoken := oc sa get-token oauth-client
oc new-app -p OPENSHIFT_OAUTH_CLIENT_SECRET=#{mytoken}

CDK は、開発を支援する共通の OpenShift カスタマイズを提供する一連のビルトインアドオンを提供します。minishift setup-cdk では、Minishift は自動的に xpaas アドオン、anyuid アドオン、および admin-user アドオンをインストールして有効にします。デフォルトのアドオンをインストールするには、以下を実行します。

$ minishift addons install --defaults

このコマンドは、デフォルトのアドオンインストールディレクトリー $MINISHIFT_HOME/addons に展開します。インストールされたアドオンの一覧を表示するには、以下のコマンドを実行します。

$ minishift addons list --verbose=true

このコマンドは、インストールされているアドオンの一覧を出力します。少なくとも、anyuid アドオンが表示されるはずです。これは、事前に割り当てられた UID を使用しないイメージを実行できるようにする重要なアドオンです。デフォルトでは、これは OpenShift では使用できません。

アドオンは minishift addons install コマンドでインストールされます。

以下の例は、アドオンのインストール方法を示しています。

$ minishift addons install <path_to_addon_directory>

アドオンは minishift addons enable コマンドで有効にされ、minishift addons disable コマンドで無効にされます。有効にするアドオンは、minishift start 時に自動的に実行されます。

以下の例は、anyuid アドオンを有効にして無効にする方法を示しています。

$ minishift addons enable anyuid

$ minishift addons disable anyuid

$ minishift addons enable registry --priority=5

$ minishift addons list
- anyuid         : enabled    P(0)
- registry       : enabled    P(5)
- eap            : enabled    P(10)

アドオンは minishift addons apply コマンドを使用して明示的に実行できます。有効なアドオンと無効なアドオンの両方に apply コマンドを使用できます。1 つのコマンドで複数のアドオンを適用するには、スペースで区切られたアドオン名を指定します。

以下の例は、anyuid アドオンおよび admin-user アドオンを明示的に適用する方法を示しています。

$ minishift addons apply anyuid admin-user

アドオンは minishift addons remove コマンドを使用して削除できます。これは minishift addons apply のミラーコマンドであり、アドオンが有効かどうかに関わらず、同様に使用できます。指定したアドオンがインストールされ、<addon_name>.addon.remove ファイルがある場合、minishift addons remove は、このファイルで指定されたコマンドを実行します。

1 つのコマンドで複数のアドオンを削除するには、スペースで区切られたアドオン名を指定します。以下の例は、admin-user アドオンを明示的に削除する方法を示しています。

$ minishift addons remove admin-user
-- Removing addon 'admin-user':.
admin user deleted

アドオンは、minishift addons uninstall コマンドを使用してアンインストールできます。これは minishift addons install のミラーコマンドであり、アドオンが有効かどうかに関わらず、同様に使用できます。指定したアドオンがインストールされている場合、minishift addons uninstall は対応するアドオンディレクトリーを $MINISHIFT_HOME/addons から削除します。

以下の例は、admin-user アドオンを明示的にアンインストールする方法を示しています。

$ minishift addons uninstall admin-user
Add-on 'admin-user' uninstalled

カスタムアドオンを作成するには、ディレクトリーを作成し、そのディレクトリーに、拡張子 .addon で少なくとも 1 つのテキストファイルを作成する必要があります (例: admin-role.addon)。

このファイルには、アドオンの一部として実行するコマンドと、Name および Description メタデータフィールドが含まれている必要があります。

以下の例は、開発者ユーザーに cluster-admin 権限を付与するアドオンの定義を示しています。

# Name: admin-role
# Description: Gives the developer user cluster-admin privileges

oc adm policy add-role-to-user cluster-admin developer

アドオンを定義したら、以下を実行してインストールできます。

$ minishift addons install <ADDON_DIR_PATH>

# Name: prometheus
# Description: This template creates a Prometheus instance preconfigured to gather OpenShift and
# Kubernetes platform and node metrics and report them to admins. It is protected by an
# OAuth proxy that only allows access for users who have view access to the prometheus
# namespace. You may customize where the images (built from openshift/prometheus
# and openshift/oauth-proxy) are pulled from via template parameters.
# Url: https://prometheus.io/

CDK アドオンインストールディレクトリー $MINISHIFT_HOME/addons で、アドオンを直接編集することもできます。アドオンにエラーがある場合は、addons コマンドの実行時には表示されませんが、これは minishift start プロセス中は適用されないことに注意してください。

アドオンの削除手順を提供するには、拡張子 .addon.remove でテキストファイルを作成できます (例: admin-user.addon.remove)。.addon ファイルと同様に、Name および Description メタデータフィールドが必要です。.addon.remove ファイルが存在する場合は、remove コマンドで適用できます。

ホストフォルダーは、ホストと CDK 仮想マシンとの間で共有されるホストのディレクトリーです。これにより、ホストと仮想マシンの間の 2 方向ファイル同期が可能になります。以下のセクションでは、minishift hostfolder コマンドの使用方法を説明します。

CDK は、ホストフォルダーの一覧表示、追加、マウント、マウント解除、および削除を行う minishift hostfolder コマンドを提供します。hostfolder コマンドを使用して、複数の共有フォルダーをカスタム指定のマウントポイントにマウントできます。

$ minishift hostfolder list
Name    Type    Source               Mountpoint       Mounted
test    sshfs   /Users/user/test     /mnt/sda1/test   N

$ minishift hostfolder add -t cifs --source //192.168.99.1/MYSHARE --target /mnt/sda1/myshare --options username=user,password=mysecret,domain=MYDOMAIN myshare

$ minishift hostfolder add -t sshfs --source /Users/user/myshare --target /mnt/sda1/myshare myshare

$ minishift hostfolder add -t sshfs --source ~/myshare/ --target /mnt/sda1/myshare --options "-o compression=no" myshare

$ minishift hostfolder mount myshare

$ minishift hostfolder list
Name       Mountpoint          Remote path              Mounted
myshare    /mnt/sda1/myshare   //192.168.99.1/MYSHARE   Y

$ minishift ssh "ls -al /mnt/sda1/myshare"

$ minishift config set hostfolders-sftp-port 2222

$ minishift config set hostfolders-automount true

$ minishift hostfolder umount myshare

$ minishift hostfolder list
Name       Mountpoint          Remote path              Mounted
myshare    /mnt/sda1/myshare   //192.168.99.1/MYSHARE   N

$ minishift hostfolder list
Name        Mountpoint            Remote path              Mounted
myshare     /mnt/sda1/myshare     //192.168.1.82/MYSHARE   N

$ minishift hostfolder remove myshare

$ minishift hostfolder list
No host folders defined

ほとんどのハイパーバイザーは、DHCP を使用して IP が割り当てられる際のリース時間の延長に対応していません。これにより、再起動後に仮想マシンに新しい IP が割り当てられる可能性があります。古い IP 用に生成されたセキュリティー証明書と競合するためです。これにより、minishift delete に続いて minishift start を実行して新規インスタンスが設定されるまで CDK は完全に使用できなくなります。

これを防ぐために、CDK には、静的 IP アドレスを仮想マシンに設定する機能が含まれます。これにより、再起動間で IP アドレスが変更されなくなります。ただし、IP アドレスの解決方法により、現時点ではすべてのドライバープラグインで機能しません。

Internal Virtual Switch for Hyper-V では DHCP が提供するオプションはないため、IP アドレスは別の方法で提供する必要があります。Data Exchange Service for Hyper-V を使用して、起動時に IP アドレスを割り当てる機能が提供されます。

この機能を有効にするには、NAT を使用して仮想スイッチ を作成する必要があります。

以下のコマンドは、内部仮想スイッチ「MyInternal」で使用する IP アドレスの割り当てを試みます。

PS> minishift.exe config set hyperv-virtual-switch "MyInternal"
PS> minishift.exe start `
  --network-ipaddress 192.168.1.10 `
  --network-gateway 192.168.1.1 `
  --network-nameserver 8.8.8.8

「DockerNAT」ネットワークを使用する場合は、正しい NAT ネットワークを設定し、予想される範囲の IP を割り当てる必要があります。

PS> New-NetNat -Name SharedNAT -InternalIPInterfaceAddressPrefix 10.0.75.1/24
PS> minishift.exe config set hyperv-virtual-switch "DockerNAT"
PS> minishift.exe start `
  --network-ipaddress 10.0.75.128 `
  --network-gateway 10.0.75.1 `
  --network-nameserver 8.8.8.8

以下のコマンドは、固定で割り当てられた IP アドレスを設定します。

$ minishift ip --set-static

動的割り当てを使用する場合は、以下を使用できます。

$ minishift ip --set-dhcp

単一の仮想マシンで OpenShift を実行する場合は、他の Docker のユースケース向けに CDK によって管理される Docker デーモンを再利用できます。CDK と同じ Docker デーモンを使用することで、ローカル開発を迅速化できます。

CDK Docker デーモンを再利用するようにコンソールを設定するには、以下の手順に従います。

今後の機能および実験的機能に早期にアクセスしたい場合は、環境変数 MINISHIFT_ENABLE_EXPERIMENTAL を設定できます。これにより、追加の機能フラグが利用できるようになります。

$ export MINISHIFT_ENABLE_EXPERIMENTAL=y

デフォルトでは、CDK は CDK CLI のすべての oc cluster up フラグを公開しません。

MINISHIFT_ENABLE_EXPERIMENTAL 環境変数を設定して、minishift start コマンドで以下のオプションを有効にします。

たとえば、以下のコマンドは OpenShift の サービスカタログ をプロビジョニングします。

$ MINISHIFT_ENABLE_EXPERIMENTAL=y minishift start --extra-clusterup-flags "--enable='*,service-catalog'"

セキュリティー証明書が組織で使用されるものの、インスタンスと簡単に共有できない状況では、CDK インスタンスが外部リソースにアクセスするために使用できるホストでローカルプロキシーサーバーを実行できます。

プロキシーサーバーの有効化は、以下のコマンドを使用して行います。

$ minishift config set local-proxy true

これにより、CDK インスタンスに自動的に割り当てられるホストでプロキシーサーバーを起動します。

企業またはアップストリームのプロキシーが分かっている場合は、以下の設定オプションで指定できます。

$ minishift config set local-proxy-upstream http(s)://[username:password@]host:port

このオプションを使用すると、すべてのトラフィックが CDK 固有の証明書で再暗号化されます。このため、このプロキシーは、CDK の開発および使用のみに使用する必要があります。

CDK は、オフラインの使用のために DNS サーバーを提供し、テスト中に DNS レコードを上書きする可能性があります。これにより、インターネットなしで OpenShift ルートにアクセスできます。

DNS サーバーの起動は、以下のように実行できます。

$ minishift dns start

DNS サーバーを起動したら、このネームサーバーを使用するようにデバイス設定を設定する必要があります。start コマンドには、オフラインでの使用を入力したときに使用できる一時的なオプションが表示されます。

DNS サーバーの停止は、以下のように実行できます。

$ minishift dns stop

DNS サーバーの状態を取得するには、次のコマンドを実行します。

$ minishift dns status

$ ls /dev | grep tap

$ brew install tuntap

<key>D16F22CE-6DDE-4E63-837C-E16538EA5CCB</key>	1
<dict>
    <key>DNS</key>
    <dict />
    <key>IPv4</key>
    <dict>
        <key>Addresses</key>
        <array>
            <string>10.10.90.1</string>		2
        </array>
        <key>ConfigMethod</key>
        <string>Manual</string>
        <key>SubnetMasks</key>
        <array>
            <string>255.255.0.0</string>
        </array>
    </dict>
    <key>IPv6</key>
    <dict>
        <key>ConfigMethod</key>
        <string>Automatic</string>
    </dict>
    <key>Interface</key>
    <dict>
        <key>DeviceName</key>
        <string>tap0</string>			3
        <key>Hardware</key>
        <string>Ethernet</string>
        <key>Type</key>
        <string>Ethernet</string>
        <key>UserDefinedName</key>
        <string>MiniTap</string>		4
    </dict>
    <key>Proxies</key>
    <dict>
        <key>ExceptionsList</key>
        <array>
            <string>*.local</string>
            <string>169.254/16</string>
        </array>
        <key>FTPPassive</key>
        <integer>1</integer>
    </dict>
    <key>SMB</key>
    <dict />
    <key>UserDefinedName</key>
    <string>MiniTap</string>			5
</dict>

<key>ServiceOrder</key>
    <array>
        <string>06BFF3C7-13DA-420F-AE9C-B036401184D7</string>
	<string>58231F56-CA25-4D41-930F-46D83CA07BFE</string>
	<string>304203B0-AC87-459F-9761-C2799EEBB2E3</string>
	<string>8655D244-C6E7-4CC0-BF06-BB18F9C3BB85</string>
	<string>3C26FB9D-D918-4B79-9C7B-ADECD8EFE00F</string>
	<string>D16F22CE-6DDE-4E63-837C-E16538EA5CCB</string>	1
    </array>

<key>Service</key>
    <dict>
        <key>06BFF3C7-13DA-420F-AE9C-B036401184D7</key>
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/06BFF3C7-13DA-420F-AE9C-B036401184D7</string>
        </dict>
        <key>304203B0-AC87-459F-9761-C2799EEBB2E3</key>
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/304203B0-AC87-459F-9761-C2799EEBB2E3</string>
        </dict>
        <key>3C26FB9D-D918-4B79-9C7B-ADECD8EFE00F</key>
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/3C26FB9D-D918-4B79-9C7B-ADECD8EFE00F</string>
        </dict>
        <key>58231F56-CA25-4D41-930F-46D83CA07BFE</key>
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/58231F56-CA25-4D41-930F-46D83CA07BFE</string>
        </dict>
        <key>8655D244-C6E7-4CC0-BF06-BB18F9C3BB85</key>
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/8655D244-C6E7-4CC0-BF06-BB18F9C3BB85</string>
        </dict>
        <key>D16F22CE-6DDE-4E63-837C-E16538EA5CCB</key>				  1
        <dict>
            <key>__LINK__</key>
            <string>/NetworkServices/D16F22CE-6DDE-4E63-837C-E16538EA5CCB</string>2
        </dict>
    </dict>

$ exec 4<>/dev/tap0			1
$ ifconfig tap0 10.10.90.1 255.255.0.0  2 3
$ ifconfig tap0 up			4

nameserver <ip_address_of_the_minishfit_vm>
search_order 1

macOS および Windows で CDK のユーザーが GUI からプロファイルを開始および停止するなどの単純なタスクを実行するのに役立つため、実験的なシステムトレイを含むように、これらのプラットフォームのバイナリーがコンパイルされています。

デフォルトでは、システムトレイは minishift start の実行時に自動的に起動します。この動作を無効にするには、次のコマンドを使用します。

$ minishift config set auto-start-tray false

システムトレイを起動するには、次のコマンドを実行します。

$ minishift service start systemtray

デフォルトとは異なるタイムゾーンを設定する場合は、以下のコマンドを使用します。

$ minishift timezone --set <Valid_Timezone>

利用可能なタイムゾーンを表示するには、以下のコマンドを使用します。

$ minishift timezone --list

CDK インスタンスの現在のタイムゾーンを確認するには、次のコマンドを実行します。

$ minishift timezone

CDK は、vm-driver を 汎用的 に使用して、既存のリモートマシンに対して実行できます。

CDK を持つ既存のマシンを使用するには、以下のように設定する必要があります。

ホストで次のコマンドを実行し、リモートマシンに対して CDK を実行します。

$ minishift start --vm-driver generic --remote-ipaddress <remote_IP_address> --remote-ssh-user <username> --remote-ssh-key <private_ssh_key>
$ minishift addon apply htpasswd-identity-provider --addon-env USER_PASSWORD=<NEW_PASSWORD>

Kompose は、Docker Compose を OpenShift や Kubernetes などのコンテナーオーケストレーターに変換するツールです。Kompose は、手動またはパッケージマネージャー (Microsoft Windows の Chocolatey、macOS の Homebrew、または Red Hat Enterprise Linux の Yum）からインストールできます。

PS> choco.exe install kubernetes-kompose

$ brew install kompose

$ subscription-manager repos --enable rhel-7-server-devtools-rpms
$ subscription-manager repos --enable rhel-server-rhscl-7-rpms
$ yum install kompose -y

Kompose を使用して Docker Compose プロジェクトを変換するには、以下の手順に従います。

minishift start コマンドは、cluster up 方法を使用してOpenShift クラスターを作成します。このため、oc バイナリーをホストにコピーします。

oc バイナリーは、$MINISHIFT_HOME/cache/oc/v3.11.374 ディレクトリーにあります。これは、CDK のデフォルトの OpenShift バージョンを使用することを前提とします。minishift oc-env を使用してこのバイナリーを PATH に追加できます。これは、シェルに入力する必要のあるコマンドを表示します。

minishift oc-env の出力は、オペレーティングシステムとシェルタイプによって異なります。

$ minishift oc-env
export PATH="/home/user/.minishift/cache/oc/v3.11.374:$PATH"
# Run this command to configure your shell:
# eval $(minishift oc-env)

minishift start コマンドの一環として、minishift という名前の CLI プロファイル も作成されます。このプロファイルは コンテキスト とも呼ばれ、OpenShift クラスターと通信するための設定が含まれます。

CDK は自動的にこのコンテキストをアクティベートしますが、たとえば別の OpenShift インスタンスにログインした後にそのコンテキストに戻す必要がある場合は、以下を実行します。

$ oc config use-context minishift

oc の使用方法の概要は、OpenShift ドキュメントの「CLI の使用方法」トピックを参照してください。

デフォルトでは、cluster upは、AllowAllPasswordIdentityProvider を使用してローカルクラスターに対して認証を行います。つまり、空でないユーザー名およびパスワードを使用してローカルクラスターにログインできます。

推奨されるユーザー名およびパスワードは、それぞれ developer と developer です。これは、そのユーザーおよびパスワードがすでにデフォルトのプロジェクト myproject に割り当てられており、管理者の 権限を借用 できるためです。これにより、--as system:admin パラメーターを使用して管理者コマンドを実行できます。

管理者としてログインするには、システムアカウントを使用します。

$ oc login -u system:admin

この場合は、クライアント証明書 が使用されます。証明書は ~/.kube/config に保存されます。cluster up コマンドは、ブートストラップの一部として適切な証明書をインストールします。

利用可能なログインコンテキストを表示するには、以下を実行します。

$ oc config view

OpenShift Web コンソール にアクセスするには、CDK を起動して Web コンソールの URL を取得するために、シェルでこのコマンドを実行します。

$ minishift console --url

または、CDK の起動後、以下のコマンドを使用してブラウザーでコンソールを直接開くことができます。

$ minishift console

ルートで公開されるサービスにアクセスするには、シェルで以下のコマンドを実行します。

$ minishift openshift service [-n NAMESPACE] [--url] NAME

詳細は、「サービスの公開」も参照してください。

OpenShift ログにアクセスするには、CDK の起動後に以下のコマンドを実行します。

$ minishift logs

OpenShift の実行中に、クラスターのマスターまたはノード設定を表示および変更できます。

OpenShift マスター設定ファイル master-config.yaml を表示するには、以下のコマンドを実行します。

$ minishift openshift config view

マスター設定の代わりにノードまたは kubeapi-server 設定を表示するには、target フラグを指定します。

view サブコマンドの詳細は、minishift openshift config view の概要を参照してください。

$  minishift openshift config set --patch '{"corsAllowedOrigins": [".*"]}'

PS> minishift.exe openshift config set --patch '{\"corsAllowedOrigins\": [\".*\"]}'

C:\> minishift.exe openshift config set --patch "{\"corsAllowedOrigins\": [\".*\"]}"

$ minishift openshift config set --patch '{"routingConfig": {"subdomain": "<IP-ADDRESS>.xip.io"}}'

コンポーネントを実行中の OpenShift クラスターに追加するには、以下を使用します。

$ minishift openshift component add <component-name>

$ minishift openshift component add service-catalog

実行中の OpenShift クラスターに追加できる有効なコンポーネントを一覧表示するには、以下を実行します。

$ minishift openshift component list

OpenShift にデプロイした後にサービスを公開する方法は複数あります。以下のセクションでは、さまざまな方法とそれらを使用するタイミングを説明します。

Web アプリケーションをデプロイする場合、そのアプリケーションを公開する最も一般的な方法は ルート による方法です。ルートはサービスをホスト名として公開します。Web コンソールまたは CLI を使用してルートを作成できます。

$ oc expose svc/frontend --hostname=www.example.com

アプリケーションを作成し、これをルートで公開する完全な例は、「サンプルアプリケーションのデプロイ」セクションを参照してください。

公開するサービスが HTTP ベースではない場合には、NodePort サービスを作成できます。この場合、各 OpenShift ノードは、そのポートをサービスにプロキシーします。CDK 仮想マシンでこのポートにアクセスするには、type=LoadBalancer パラメーターで oc expose を使用して Ingress IP を設定する必要があります。

Ingress IP Self-Service の一般的なユースケースは、データベースサービスを公開する機能です。CDK を使用して MariaDB インスタンスを作成および公開する完全なワークフローの例を以下に示します。

$ minishift start
$ eval $(minishift oc-env)
$ oc new-app -e MYSQL_ROOT_PASSWORD=admin https://raw.githubusercontent.com/openshift/origin/master/examples/db-templates/mariadb-persistent-template.json
$ oc rollout status -w dc/mariadb
$ oc expose dc mariadb --type=LoadBalancer --name=mariadb-ingress
$ oc export svc mariadb-ingress
 ....
ports:
    - nodePort: 30907
 ....

サービスが公開されると、CDK 仮想マシン IP および公開された NodePort サービスを使用して、CLI の mysql で MariaDB にアクセスできます。

$ mysql --user=root --password=admin --host=$(minishift ip) --port=30907

OpenShift は、開発に使用できる統合 Docker レジストリーを提供します。レジストリーに存在するイメージはアプリケーションに直接使用でき、ローカル開発ワークフローを高速化できます。

以下の例は、ローカルにビルドされた Docker イメージから OpenShift アプリケーションを直接デプロイする方法を示しています。この例では、OpenShift プロジェクト myproject を使用します。このプロジェクトは、minishift start により自動的に作成されます。

$ oc run myapp --image 172.30.1.1:5000/myproject/myapp

本セクションでは、CDK のインストールおよび設定中に発生する可能性のある一般的な問題の解決策を説明します。

CDK が起動する間、起動チェックが複数実行され、CDK 仮想マシンと OpenShift クラスターが問題なく起動できることを確認します。設定が正しくない、または存在しない場合は、起動チェックに失敗し、CDK が起動しません。

以下のセクションでは、さまざまな起動チェックを説明します。

$ minishift config set skip-check-storage-usage true

$ minishift config set check-network-ping-host <host-IP-address>

$ minishift config set check-network-http-host <URL>

minishift console は、バージョン 10.1.2 (12603.3.8) などの旧バージョンの Safari Web ブラウザーでは機能しません。Web コンソールにアクセスしようとすると、以下のエラーが発生します。

Error unable to load details about the server

これについては、最新バージョンに更新するか、Firefox または Chrome ブラウザーを使用します。バージョン 11.0.3 (13604.5.6) はテストされ、OpenShift Web コンソールと動作します。minishift console --url を使用して Web コンソール URL を取得できます。

本セクションでは、CDK のドライバープラグインを設定する際に発生する可能性のある一般的な問題の解決策を説明します。

本セクションでは、CDK のさまざまなコンポーネントの使用中に発生する可能性のある一般的な問題の解決策を説明します。

追加パッケージをインストールしたり、CDK 仮想マシンのルートファイルシステムにコピーしたり、割り当てたオーバーレイサイズを超えたり、CDK 仮想マシンをロックする可能性があります。

原因: CDK 仮想マシンルートファイルシステムには、CDK 仮想マシンおよびコンテナーの実行を最適化するように設定されたコアパッケージが含まれています。root ファイルシステムで利用可能なストレージは、オーバーレイサイズにより決定されます。これは、利用可能なストレージの合計よりも小さくなります。

回避策: CDK 仮想マシンの root ファイルシステムにパッケージをインストールしたり、大きなファイルを保存したりします。その代わりに、/mnt/sda1/ 永続ストレージボリュームにサブディレクトリーを作成したり、ホストと CDK 仮想マシンとの間でストレージ領域を共有できる ホストフォルダー を定義してマウントしたりできます。

CDK 仮想マシン内で開発タスクを実行する場合は、永続ストレージボリュームに保存され、CDK Docker デーモンを再利用する コンテナーを使用することが推奨されます。

オペレーティングシステムおよびシェル環境によっては、特定の特殊文字が変数挿入をトリガーするため、パスワードが失敗します。

回避策: パスワードを作成して入力する場合は、'<password>' の形式で文字列を一重引用符で囲みます。

Microsoft Edge を使用して OpenShift Web コンソールにアクセスしようとすると、以下のエラーが発生します。

Site not reachable.

OpenShift Web コンソールは、空のページとしてレンダリングされる可能性があります。

原因: Microsoft Edg が原因で発生したエラーです。

回避策: 代替の Web ブラウザーを使用して OpenShift Web コンソールにアクセスします。Mozilla Firefox と Google Chrome はどちらも期待どおりに機能します。

停止した CDK 仮想マシンを起動すると、以下の X.509 証明書エラーが発生します。

$ minishift start
-- Checking if requested hypervisor 'kvm' is supported on this platform ... OK
-- Checking the ISO URL ... OK
-- Starting local OpenShift cluster using 'kvm' hypervisor ...
-- Starting Minishift VM ......................... OK
[...]
FAIL
   Error: cannot access master readiness URL https://192.168.99.101:8443/healthz/ready
   Details:
     No log available from "origin" container

   Caused By:
     Error: Get https://192.168.99.101:8443/healthz/ready: x509: certificate is valid for 10.0.2.15, 127.0.0.1, 172.17.0.1, 172.30.0.1, 192.168.99.100, not 192.168.99.101
Error during 'cluster up' execution: Error starting the cluster.

上記のエラーの原因は、OpenShift クラスター証明書に CDK 仮想マシンの IP が含まれることです。証明書は、CDK 仮想マシンが新たに起動する場合にのみ生成されます。再起動後、CDK 仮想マシンに新しい IP アドレスが割り当てられる可能性があります。この場合は、証明書が無効になります。

回避策: 既存の CDK 仮想マシンを削除して、再起動します。

$ minishift delete --force
$ minishift start