第2章 Projects
2.1. プロジェクトの使用 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクト を使用することにより、あるユーザーコミュニティーは、他のコミュニティーと切り離された状態で独自のコンテンツを整理し、管理することができます。
openshift- および kube- で始まる名前のプロジェクトはデフォルトプロジェクトです。詳細は、デフォルトプロジェクトを参照してください。これらのプロジェクトは、Pod として実行されるクラスターコンポーネントおよび他のインフラストラクチャーコンポーネントをホストします。そのため、OpenShift Container Platform では oc new-project コマンドを使用して openshift- または kube- で始まる名前のプロジェクトを作成することができません。クラスター管理者は、oc adm new-project コマンドを使用してこれらのプロジェクトを作成できます。
デフォルトプロジェクトでワークロードを実行したり、デフォルトプロジェクトへのアクセスを共有したりしないでください。デフォルトのプロジェクトは、コアクラスターコンポーネントを実行するために予約されています。
デフォルトプロジェクトである default、kube-public、kube-system、openshift、openshift-infra、openshift-node、および openshift.io/run-level ラベルが 0 または 1 に設定されているその他のシステム作成プロジェクトは、高い特権があるとみなされます。Pod セキュリティーアドミッション、Security Context Constraints、クラスターリソースクォータ、イメージ参照解決などのアドミッションプラグインに依存する機能は、高い特権を持つプロジェクトでは機能しません。
OpenShift Container Platform Web コンソールまたは OpenShift CLI (oc)のいずれかで以下のタスクを実行できます。
- クラスターにプロジェクトを作成します。
- プロジェクトを表示します。
- プロジェクトのステータスを確認します。
- プロジェクトを削除します。
プロジェクトを削除する際に、サーバーはプロジェクトのステータスを Active から Terminating に更新します。次に、サーバーは Terminating 状態のプロジェクトからすべてのコンテンツをクリアしてから、最終的にプロジェクトを削除します。プロジェクトのステータスが Terminating の場合は、新規のコンテンツをプロジェクトに追加することができません。
2.1.1. Web コンソールを使用したプロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールを使用して、クラスター内にプロジェクトを作成できます。
openshift- および kube- で始まる名前のプロジェクトは OpenShift Container Platform によって重要 (Critical) と見なされます。そのため、OpenShift Container Platform では、Web コンソールを使用して openshift- で始まるプロジェクトを作成することはできません。
前提条件
- OpenShift Container Platform のプロジェクト、アプリケーション、および他のワークロードを作成するために適切なロールおよびパーミッションがある。
手順
Administrator パースペクティブを使用している場合は、以下を行います。
-
Home
Projects に移動します。 Create Project をクリックします。
-
Create Project ダイアログボックスで、Name フィールドに、
myprojectなどの一意の名前を入力します。 - オプション: プロジェクトの Display name および Description の詳細を追加します。
Create をクリックします。
プロジェクトのダッシュボードが表示されます。
-
Create Project ダイアログボックスで、Name フィールドに、
- オプション: Details タブを選択して、プロジェクトの詳細を表示します。
-
オプション:プロジェクトに対する適切なパーミッションがある場合は、Project Access タブを使用して、プロジェクトの
admin、edit、およびview権限を提供するか、取り消します。
-
Home
Developer パースペクティブを使用している場合は、以下を行います。
Project メニューをクリックし、Create Project を選択します。
図2.1 Create project
-
Create Project ダイアログボックスで、Name フィールドに、
myprojectなどの一意の名前を入力します。 - オプション: プロジェクトの Display name および Description の詳細を追加します。
- Create をクリックします。
-
Create Project ダイアログボックスで、Name フィールドに、
- オプション: 左側のナビゲーションパネルを使用して Project ビューに移動し、プロジェクトのダッシュボードを表示します。
- オプション: プロジェクトダッシュボードで Details タブを選択し、プロジェクトの詳細を表示します。
- オプション: プロジェクトに対する適切なパーミッションがある場合は、プロジェクトダッシュボードの Project Access タブを使用して、プロジェクトの admin、edit、および view 権限を付与または取り消すことができます。
2.1.2. CLI を使用したプロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者が必要なパーミッションを提示している場合は、新規プロジェクトを作成できます。
openshift- および kube- で始まる名前のプロジェクトは OpenShift Container Platform によって重要 (Critical) と見なされます。OpenShift Container Platform では、oc new-project コマンドを使用して、openshift- または kube- で始まるプロジェクトを作成することはできません。クラスター管理者は、oc adm new-project コマンドを使用してこれらのプロジェクトを作成できます。
手順
プロジェクトを作成するには、以下のコマンドを入力します。
$ oc new-project <project_name> \ --description="<description>" --display-name="<display_name>"以下の例では、実際の値を使用します。
$ oc new-project hello-openshift \ --description="This is an example project" \ --display-name="Hello OpenShift"注記作成できるプロジェクトの数は、システム管理者によって制限される場合があります。上限に達すると、新規プロジェクトを作成するために既存プロジェクトを削除しなければならない場合があります。
2.1.3. Web コンソールを使用してプロジェクトを表示する リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform Web コンソールを使用して、アクセス権のあるプロジェクトを表示できます。
OpenShift Container Platform 4.19 以降、Web コンソールのパースペクティブが統合されました。Developer パースペクティブは、デフォルトでは有効になっていません。
すべてのユーザーは、OpenShift Container Platform Web コンソールのすべての機能を操作できます。ただし、クラスターの所有者でない場合は、特定の機能にアクセスする権限をクラスターの所有者に要求する必要がある場合があります。
引き続き Developer パースペクティブを有効にできます。Web コンソールの Getting Started ペインでは、コンソールツアーの実行、クラスター設定に関する情報の検索、Developer パースペクティブを有効にするためのクイックスタートの表示、リンク先を表示して新機能の確認などを行えます。
手順
管理者としてログインしている場合は、以下の手順を実行します。
-
ナビゲーションメニューで Home
Projects に移動します。 - 表示するプロジェクトを選択します。Overview タブには、プロジェクトのダッシュボードが含まれています。
- Details タブを選択して、プロジェクトの詳細を表示します。
- YAML タブを選択して、プロジェクトリソースの YAML 設定を表示および更新します。
- Workloads タブを選択して、プロジェクト内のワークロードを表示します。
- RoleBindings タブを選択して、プロジェクトのロールバインディングを表示および作成します。
-
ナビゲーションメニューで Home
開発者としてログインしている場合は、次の手順を実行します。
- ナビゲーションメニューの Project ページに移動します。
- 画面上部の Project ドロップダウンメニューから All Projects を選択し、クラスター内のすべてのプロジェクトをリスト表示します。
- 表示するプロジェクトを選択します。
- Details タブを選択して、プロジェクトの詳細を表示します。
- プロジェクトに十分なパーミッションがある場合は、Project access タブを選択して、プロジェクトの権限を表示および更新します。
2.1.4. CLI を使用したプロジェクトの表示 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクトを表示する際は、認証ポリシーに基づいて、表示アクセスのあるプロジェクトだけを表示できるように制限されます。
手順
プロジェクトのリストを表示するには、以下のコマンドを入力します。
$ oc get projectsCLI 操作について現在のプロジェクトから別のプロジェクトに変更するには、以下のコマンドを入力します。その後の操作についてはすべて指定のプロジェクトが使用され、プロジェクトスコープのコンテンツの操作が実行されます。
$ oc project <project_name>
2.1.5. Developer パースペクティブを使用したプロジェクトに対するアクセスパーミッションの提供 リンクのコピーリンクがクリップボードにコピーされました!
Developer パースペクティブで Project ビューを使用し、プロジェクトに対するアクセスを付与したり、取り消したりできます。ユーザーをプロジェクトに追加し、Admin、Edit、または View アクセスを指定できます。
前提条件
- プロジェクトを作成している。
手順
- Developer パースペクティブで、Project ページに移動します。
- Project メニューからプロジェクトを選択します。
- Project Access タブを選択します。
Add access をクリックして、パーミッションの新規の行をデフォルトのパーミッションに追加します。
図2.2 プロジェクトパーミッション
- ユーザー名を入力し、Select a role ドロップダウンリストをクリックし、適切なロールを選択します。
- Save をクリックして新規パーミッションを追加します。
オプション:以下の追加タスクのいずれかを実行できます。
- Select a role ドロップダウンリストを使用して、既存ユーザーのアクセスパーミッションを変更できます。
Remove Access アイコンを使用して、既存ユーザーのプロジェクトへのアクセスパーミッションを完全に削除できます。
注記高度なロールベースのアクセス制御は、Administrator パースペクティブの Roles および Roles Binding ビューで管理されます。
2.1.6. Web コンソールを使用した利用可能なクラスターのロールのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールの Developer パースペクティブでは、Project admin、edit、および view です。
クラスター管理者は、クラスター全体のすべてのプロジェクトに対して Project access ページでどのクラスターロールを使用できるかを定義できます。Console 設定リソースの spec.customization.projectAccess.availableClusterRoles オブジェクトをカスタマイズすることで、使用可能なロールを指定できます。
前提条件
-
cluster-adminロールを持つユーザーとしてクラスターにアクセスできる。
手順
-
Administrator パースペクティブで、Administration
Cluster settings に移動します。 - Configuration タブをクリックします。
-
Configuration resource リストから、Console
operator.openshift.ioを選択します。 - YAML タブに移動し、YAML コードを表示し、編集します。
specの YAML コードで、プロジェクトアクセスに使用可能なクラスターロールのリストをカスタマイズします。次の例では、デフォルトのadmin、edit、およびviewロールを指定します。apiVersion: operator.openshift.io/v1 kind: Console metadata: name: cluster # ... spec: customization: projectAccess: availableClusterRoles: - admin - edit - view-
Save をクリックして、
Console設定リソースへの変更を保存します。
検証
- Developer パースペクティブで、Project ページに移動します。
- Project メニューからプロジェクトを選択します。
- Project access タブを選択します。
-
Role 列のメニューをクリックし、使用可能なロールが
Consoleリソース設定に適用した設定と一致することを確認します。
2.1.7. プロジェクトへの追加 リンクのコピーリンクがクリップボードにコピーされました!
+Add ページを使用して、プロジェクトにアイテムを追加できます。
前提条件
- プロジェクトを作成している。
手順
- +Add ページに移動します。
- Project メニューからプロジェクトを選択します。
+Add ページのアイテムをクリックし、ワークフローに従います。
注記+Add ページの検索機能を使用して、プロジェクトに追加する追加のアイテムを見つけることもできます。ページ上部の Add の下にある + をクリックし、検索フィールドにコンポーネントの名前を入力します。
2.1.8. Web コンソールを使用したプロジェクトのステータスの確認 リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールを使用して、プロジェクトのステータスを確認できます。
前提条件
- プロジェクトを作成している。
手順
-
Home
Projects に移動します。 - 一覧からプロジェクトを選択します。
- Overview ページで、プロジェクトのステータスを確認します。
2.1.9. CLI を使用したプロジェクトのステータスの確認 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift CLI (oc) を使用して、プロジェクトのステータスを確認できます。
前提条件
-
OpenShift CLI (
oc) がインストールされている。 - プロジェクトを作成している。
手順
プロジェクトに切り替えます。
$ oc project <project_name>-
<project_name>は、プロジェクトの名前に置き換えます。
-
プロジェクトの概要を取得します。
$ oc status
2.1.10. Web コンソールを使用したプロジェクトの削除 リンクのコピーリンクがクリップボードにコピーされました!
Web コンソールを使用してプロジェクトを削除できます。
前提条件
- プロジェクトを作成している。
- プロジェクトを削除するために必要なパーミッションを持っている。
手順
Administrator パースペクティブを使用している場合は、次の手順を実行します。
-
Home
Projects に移動します。 - 一覧からプロジェクトを選択します。
プロジェクトの Actions ドロップダウンメニューをクリックし、Delete Project を選択します。
注記プロジェクトを削除するために必要なパーミッションがない場合は、Delete Project オプションは選択できません。
- Delete Project? ペインで、プロジェクトの名前を入力して削除を確認します。
- Delete をクリックします。
-
Home
Developer パースペクティブを使用している場合は、以下の手順を実行します。
- Project ページに移動します。
- Project メニューから削除するプロジェクトを選択します。
プロジェクトの Actions ドロップダウンメニューをクリックし、Delete Project を選択します。
注記プロジェクトを削除するために必要なパーミッションがないと、Delete Project オプションを選択できません。
- Delete Project? ペインで、プロジェクトの名前を入力して削除を確認します。
- Delete をクリックします。
2.1.11. CLI を使用したプロジェクトの削除 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift CLI (oc) を使用してプロジェクトを削除できます。
前提条件
-
OpenShift CLI (
oc) がインストールされている。 - プロジェクトを作成している。
- プロジェクトを削除するために必要なパーミッションを持っている。
手順
以下のコマンドを入力してプロジェクトを削除します。
$ oc delete project <project_name>-
<project_name>を、削除するプロジェクトの名前に置き換えます。
-
2.2. 別のユーザーとしてのプロジェクトの作成 リンクのコピーリンクがクリップボードにコピーされました!
権限借用を使用して、別のユーザーアカウントの代わりにプロジェクトを作成できます。
2.2.1. API の権限借用 リンクのコピーリンクがクリップボードにコピーされました!
OpenShift Container Platform で API 要求を、別のユーザーとして機能するように設定できます。権限の借用を使用すると、認証情報を切り替えなくても、別のアカウントの代わりにアクションを実行できます。
2.2.2. プロジェクト作成時のユーザー権限の借用 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクト要求を作成する際に別のユーザーの権限を借用できます。system:authenticated:oauth はプロジェクト要求を作成できる唯一のブートストラップグループであるため、そのグループの権限を借用する必要があります。
手順
別のユーザーの代わりにプロジェクト要求を作成するには、以下を実行します。
$ oc new-project <project> --as=<user> \ --as-group=system:authenticated --as-group=system:authenticated:oauth
2.3. プロジェクト作成の設定 リンクのコピーリンクがクリップボードにコピーされました!
クラスター管理者は、開発者やサービスアカウントが独自のプロジェクトを作成し、プロジェクトの セルフプロビジョニング を実行することを許可し、その方法を設定できます。
OpenShift Container Platform では、プロジェクト は関連するオブジェクトをグループ分けし、分離するために使用されます。Web コンソールまたは oc new-project コマンドを使用して新規プロジェクトの作成を要求すると、OpenShift Container Platform のエンドポイントはテンプレートに従ってプロジェクトをプロビジョニングします。必要に応じて、このテンプレートをカスタマイズできます。
2.3.1. プロジェクト作成について リンクのコピーリンクがクリップボードにコピーされました!
新規プロジェクトを要求すると、OpenShift Container Platform API サーバーはプロジェクトテンプレートに基づいて新規プロジェクトを自動的にプロビジョニングします。プロジェクトテンプレートは、クラスターのプロジェクト設定リソースの projectRequestTemplate パラメーターで識別されます。
パラメーターが定義されていない場合、API サーバーは要求される名前でプロジェクトを作成するデフォルトテンプレートを作成します。次に、API サーバーは要求するユーザーをそのプロジェクトの admin ロールに割り当てます。
プロジェクト要求が送信されると、API はテンプレートで以下のパラメーターを置き換えます。
| パラメーター | 説明 |
|---|---|
|
| プロジェクトの名前。必須。 |
|
| プロジェクトの表示名。空である可能性があります。 |
|
| プロジェクトの説明。空である可能性があります。 |
|
| 管理ユーザーのユーザー名。 |
|
| 要求するユーザーのユーザー名。 |
API へのアクセスは、self-provisioner ロールと self-provisioners のクラスターロールバインディングで開発者に付与されます。デフォルトで、このロールはすべての認証された開発者が利用できます。
2.3.2. 新規プロジェクトのテンプレートの変更 リンクのコピーリンクがクリップボードにコピーされました!
プロジェクトの新規作成時にて寄与言うされるリソースや設定をカスタマイズするために、デフォルトのプロジェクトテンプレートを変更するには、カスタムプロジェクトテンプレートを作成できます。
クラスター管理者は、デフォルトのプロジェクトテンプレートを変更し、新規プロジェクトをカスタム要件に基づいて作成できます。
独自のカスタムプロジェクトテンプレートを作成するには、以下を実行します。
前提条件
-
cluster-adminパーミッションを持つアカウントを使用して OpenShift Container Platform クラスターにアクセスできる。
手順
-
cluster-admin権限を持つユーザーとしてログインします。 デフォルトのプロジェクトテンプレートを生成します。
$ oc adm create-bootstrap-project-template -o yaml > template.yaml-
オブジェクトを追加するか、既存オブジェクトを変更することにより、テキストエディターで生成される
template.yamlファイルを変更します。 プロジェクトテンプレートは、
openshift-confignamespace に作成する必要があります。変更したテンプレートを読み込みます。$ oc create -f template.yaml -n openshift-configWeb コンソールまたは CLI を使用し、プロジェクト設定リソースを編集します。
Web コンソールを使用して、以下のタスクを実行します。
-
Administration
Cluster Settings ページに移動します。 - Configuration をクリックし、すべての設定リソースを表示します。
- Project のエントリーを見つけ、Edit YAML をクリックします。
-
Administration
CLI を使用して、以下のタスクを実行します。
project.config.openshift.io/clusterリソースを編集します。$ oc edit project.config.openshift.io/cluster
specセクションを、projectRequestTemplateおよびnameパラメーターを含めるように更新します。アップロードしたプロジェクトテンプレートの名前を設定するようにしてください。デフォルト名はproject-requestです。カスタムプロジェクトテンプレートを含むプロジェクト設定リソース
apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestTemplate: name: <template_name> # ...- 変更を保存した後、変更が正常に適用されたことを確認するために、新しいプロジェクトを作成します。
2.3.3. プロジェクトのセルフプロビジョニングの無効化 リンクのコピーリンクがクリップボードにコピーされました!
認証されたユーザーグループによる新規プロジェクトのセルフプロビジョニングを禁止できます。
手順
-
cluster-admin権限を持つユーザーとしてログインします。 以下のコマンドを実行して、
self-provisionersクラスターロールバインディングの使用を確認します。$ oc describe clusterrolebinding.rbac self-provisioners出力例
Name: self-provisioners Labels: <none> Annotations: rbac.authorization.kubernetes.io/autoupdate=true Role: Kind: ClusterRole Name: self-provisioner Subjects: Kind Name Namespace ---- ---- --------- Group system:authenticated:oauthself-provisionersセクションのサブジェクトを確認します。self-provisionerクラスターロールをグループsystem:authenticated:oauthから削除します。self-provisionersクラスターロールバインディングがself-provisionerロールのみをsystem:authenticated:oauthグループにバインドする場合は、以下のコマンドを実行します。$ oc patch clusterrolebinding.rbac self-provisioners -p '{"subjects": null}'self-provisionersクラスターロールバインディングがself-provisionerロールをsystem:authenticated:oauthグループ以外のユーザー、グループまたはサービスアカウントにバインドする場合は、以下のコマンドを実行します。$ oc adm policy \ remove-cluster-role-from-group self-provisioner \ system:authenticated:oauth
ロールへの自動更新を防ぐには、
self-provisionersクラスターロールバインディングを編集します。自動更新により、クラスターロールがデフォルトの状態にリセットされます。CLI を使用してロールバインディングを更新するには、以下の手順を実行します。
self-provisionersクラスターロールバインディングを編集するには、以下のコマンドを入力します。$ oc edit clusterrolebinding.rbac self-provisioners表示されるロールバインディングで、以下の例のように
rbac.authorization.kubernetes.io/autoupdateパラメーター値をfalseに設定します。apiVersion: authorization.openshift.io/v1 kind: ClusterRoleBinding metadata: annotations: rbac.authorization.kubernetes.io/autoupdate: "false" # ...
ロールバインディングを更新するには、以下の単一コマンドを実行します。
$ oc patch clusterrolebinding.rbac self-provisioners -p '{ "metadata": { "annotations": { "rbac.authorization.kubernetes.io/autoupdate": "false" } } }'
認証されたユーザーとしてログインし、ユーザーがプロジェクトをセルフプロビジョニングできなくなったことを確認します。
$ oc new-project test出力例
Error from server (Forbidden): You may not request a new project via this API.組織に固有のより有用な説明を提供できるように、このプロジェクト要求メッセージをカスタマイズすることを検討します。
2.3.4. プロジェクト要求メッセージのカスタマイズ リンクのコピーリンクがクリップボードにコピーされました!
プロジェクトのセルフプロビジョニングを実行できない開発者またはサービスアカウントは、Web コンソールまたは CLI を使用してプロジェクト作成要求を行うことができます。
デフォルトでは、以下のエラーメッセージが返されます。
You may not request a new project via this API.
クラスター管理者はこのメッセージをカスタマイズできます。メッセージを更新して、組織に固有の新規プロジェクトの要求方法の説明を提供することを検討してください。次の例は、カスタマイズされたメッセージを示しています。
-
プロジェクトを要求するには、システム管理者 (
projectname@example.com) に問い合わせてください。 -
新規プロジェクトを要求するには、
https://internal.example.com/openshift-project-requestにあるプロジェクト要求フォームに記入します。
手順
Web コンソールまたは CLI を使用し、プロジェクト設定リソースを編集します。
Web コンソールを使用して、以下の手順を実行します。
-
Administration
Cluster Settings ページに移動します。 - Configuration をクリックし、すべての設定リソースを表示します。
- Project のエントリーを見つけ、Edit YAML をクリックします。
-
Administration
CLI を使用して、以下の手順を実行します。
-
cluster-admin権限を持つユーザーとしてログインします。 project.config.openshift.io/clusterリソースを編集します。$ oc edit project.config.openshift.io/cluster
-
specセクションを、projectRequestMessageパラメーターを含むように更新し、値をカスタムメッセージに設定します。カスタムプロジェクト要求メッセージを含むプロジェクト設定リソース
apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestMessage: <message_string> # ...以下の例では、実際の値を使用します。
apiVersion: config.openshift.io/v1 kind: Project metadata: # ... spec: projectRequestMessage: To request a project, contact your system administrator at projectname@example.com. # ...- 変更を保存した後に、プロジェクトをセルフプロビジョニングできない開発者またはサービスアカウントを使用して新規プロジェクトの作成を試行します。このタスクを行うことで、変更が正常に適用されたことを確認できます。