Skip to content

Commit

Permalink
Derek Poindexter: Merge pull request #2943 from alchemy-containers/li…
Browse files Browse the repository at this point in the history
…nks-4-11-24
  • Loading branch information
Derek Poindexter committed Apr 11, 2024
1 parent 1167f23 commit f55bbdb
Show file tree
Hide file tree
Showing 6 changed files with 15 additions and 15 deletions.
4 changes: 2 additions & 2 deletions iam-api-key.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

copyright:
years: 2020, 2024
lastupdated: "2024-01-03"
lastupdated: "2024-04-11"

keywords: satellite, hybrid, multicloud

Expand Down Expand Up @@ -38,7 +38,7 @@ This API key is used to authorize actions to various {{site.data.keyword.cloud_n
- {{site.data.keyword.registrylong_notm}} for images.
- Service-to-service authorization in IAM for any {{site.data.keyword.satelliteshort}}-enabled {{site.data.keyword.cloud_notm}} services that you add to your location.

For more information, see the [{{site.data.keyword.openshiftlong_notm}} documentation](/docs/openshift?topic=openshift-access-creds#api_key_about).
For more information, see the [{{site.data.keyword.openshiftlong_notm}} documentation](/docs/openshift?topic=openshift-access-creds).

## Infrastructure provider credentials
{: #api-keys-templates}
Expand Down
14 changes: 7 additions & 7 deletions iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

copyright:
years: 2020, 2024
lastupdated: "2024-01-03"
lastupdated: "2024-04-11"

keywords: satellite, hybrid, multicloud, access, manage access

Expand All @@ -24,7 +24,7 @@ The name for the {{site.data.keyword.satellitelong_notm}} service in IAM is
- **{{site.data.keyword.satellitelong_notm}}** in the UI
- **satellite** in the API and CLI

Keep in mind that you need permissions to {{site.data.keyword.cloud_notm}} services if you use the services with {{site.data.keyword.satelliteshort}}. For example, to create and manage clusters in your {{site.data.keyword.satelliteshort}} location, you must have the [appropriate permissions to {{site.data.keyword.openshiftlong_notm}}](/docs/openshift?topic=openshift-access_reference) in IAM (**Kubernetes Service** in the UI, **containers-kubernetes** in the API and CLI).
Keep in mind that you need permissions to {{site.data.keyword.cloud_notm}} services if you use the services with {{site.data.keyword.satelliteshort}}. For example, to create and manage clusters in your {{site.data.keyword.satelliteshort}} location, you must have the [appropriate permissions to {{site.data.keyword.openshiftlong_notm}}](/docs/openshift?topic=openshift-iam-platform-access-roles) in IAM (**Kubernetes Service** in the UI, **containers-kubernetes** in the API and CLI).
{: note}


Expand Down Expand Up @@ -113,8 +113,8 @@ Resource type, IAM role, and scope of access policies
: You do not assign access policies for {{site.data.keyword.redhat_openshift_notm}} clusters in {{site.data.keyword.satelliteshort}}. Instead, access to clusters is assigned in {{site.data.keyword.cloud_notm}} IAM through {{site.data.keyword.openshiftlong_notm}} (**Kubernetes Service** in the console or `containers-kubernetes` in the API or CLI). For more information, see [Platform and service roles for {{site.data.keyword.redhat_openshift_notm}} clusters](#iam-roles-clusters).

: If you have access to a {{site.data.keyword.satelliteshort}} location or configuration, you can view the clusters that are attached to the location or configuration. However, you might not be able to access the clusters if you do not have the appropriate roles to those clusters. For example, if you have the appropriate access to a {{site.data.keyword.satelliteshort}} configuration, you might be able to list all the Kubernetes resources that run in registered clusters through the {{site.data.keyword.satelliteshort}} Config API. However, without an access policy to the individual clusters, you cannot log in to the individual clusters and use {{site.data.keyword.redhat_openshift_notm}} APIs to list Kubernetes resources. For more information, see the following topics.
- [Reference documentation](/docs/openshift?topic=openshift-access_reference) for user access permissions, including [platform](/docs/openshift?topic=openshift-access_reference) and [service](/docs/openshift?topic=openshift-access_reference) roles.
- [Assigning access to clusters](/docs/openshift?topic=openshift-users), such as setting up the API key for underlying infrastructure permissions and granting users access with {{site.data.keyword.cloud_notm}} IAM.
- [Reference documentation](/docs/openshift?topic=openshift-iam-platform-access-roles) for user access permissions, including platform and service roles.
- [Set the cluster credentials](/docs/openshift?topic=openshift-access-creds), such as setting up the API key for underlying infrastructure permissions and granting users access with {{site.data.keyword.cloud_notm}} IAM.
- [Accessing clusters](/docs/openshift?topic=openshift-access_cluster) on the public or private service endpoints, or by using an {{site.data.keyword.cloud_notm}} IAM API key such as for automation purposes.

Other managed services
Expand All @@ -131,8 +131,8 @@ Other managed services
If you create {{site.data.keyword.openshiftlong_notm}} clusters to use in your {{site.data.keyword.redhat_openshift_notm}} locations, you manage access to these clusters in IAM for the {{site.data.keyword.redhat_openshift_notm}} service, not for {{site.data.keyword.redhat_openshift_notm}}. Review the following information to manage IAM access to {{site.data.keyword.redhat_openshift_notm}} clusters.
{: shortdesc}

- [Reference documentation](/docs/openshift?topic=openshift-access_reference) for user access permissions, including [platform](/docs/openshift?topic=openshift-access_reference) and [service](/docs/openshift?topic=openshift-access_reference) roles.
- [Assigning access to clusters](/docs/openshift?topic=openshift-users), such as setting up the API key for underlying infrastructure permissions and granting users access with {{site.data.keyword.cloud_notm}} IAM.
- [Reference documentation](/docs/openshift?topic=openshift-iam-platform-access-roles) for user access permissions, including platform and service roles.
- [Set the cluster credentials](/docs/openshift?topic=openshift-access-creds), such as setting up the API key for underlying infrastructure permissions and granting users access with {{site.data.keyword.cloud_notm}} IAM.
- [Accessing clusters](/docs/openshift?topic=openshift-access_cluster) on the public or private service endpoints, or by using an {{site.data.keyword.cloud_notm}} IAM API key such as for automation purposes.

## Common use cases and roles in {{site.data.keyword.cloud_notm}}
Expand All @@ -143,7 +143,7 @@ Wondering which access roles to assign to your {{site.data.keyword.satelliteshor

| Use case | Example roles and scope |
| --- | --- |
| Creating a location | The user and the [API key that is set for the region and resource group](/docs/satellite?topic=satellite-iam-api-key) require the following permissions. **Administrator** platform role for all {{site.data.keyword.satelliteshort}} locations. The custom **{{site.data.keyword.satelliteshort}} Link Administrator** service role for {{site.data.keyword.satelliteshort}} Link. **Manager** service role to the {{site.data.keyword.cos_full_notm}} instance that backs up the location control plane data. To use automated templates such as to add hosts from AWS or Azure, the **Administrator** platform role for {{site.data.keyword.bplong_notm}} and **Administrator** platform role for Kubernetes Service. For other permissions to set up the location control plane, see [Permissions to create a cluster](/docs/openshift?topic=openshift-access_reference#cluster_create_permissions). |
| Creating a location | The user and the [API key that is set for the region and resource group](/docs/satellite?topic=satellite-iam-api-key) require the following permissions. **Administrator** platform role for all {{site.data.keyword.satelliteshort}} locations. The custom **{{site.data.keyword.satelliteshort}} Link Administrator** service role for {{site.data.keyword.satelliteshort}} Link. **Manager** service role to the {{site.data.keyword.cos_full_notm}} instance that backs up the location control plane data. To use automated templates such as to add hosts from AWS or Azure, the **Administrator** platform role for {{site.data.keyword.bplong_notm}} and **Administrator** platform role for Kubernetes Service. For other permissions to set up the location control plane, see [Permissions to create a cluster](/docs/openshift?topic=openshift-iam-platform-access-roles#cluster-create-permissions). |
| Creating a cluster in a location | See [Creating {{site.data.keyword.satelliteshort}} clusters](/docs/openshift?topic=openshift-satellite-clusters). |
| Location auditor | **Viewer** platform role for the {{site.data.keyword.satelliteshort}} location and link endpoints. **Reader** service role for the configuration resources in the location. **Reader** service role to the {{site.data.keyword.cos_full_notm}} instance that backs up the location control plane data. |
| App developers | **Viewer** platform role for the {{site.data.keyword.satelliteshort}} location. **Writer** or **Deployer** service access role for the configuration resources. **Editor** platform role and **Writer** service role to {{site.data.keyword.redhat_openshift_notm}} clusters or particular projects in a cluster.|
Expand Down
2 changes: 1 addition & 1 deletion landing.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@

{
"title": "Satellite",
"lastupdated": "2024-03-28",
"lastupdated": "2024-04-11",
"introduction": "Explore the capabilities of IBM Cloud Satellite and discover the tools to manage your locations, hosts, and app workloads. ",
"section_devtools": {
"api": "https://containers.cloud.ibm.com/global/swagger-global-api/",
Expand Down
4 changes: 2 additions & 2 deletions responsibilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

copyright:
years: 2020, 2024
lastupdated: "2024-01-29"
lastupdated: "2024-04-11"

keywords: satellite, hybrid, multicloud, RACI, responsibilities, shared responsibilities

Expand Down Expand Up @@ -108,7 +108,7 @@ Identity and access management includes tasks such as authentication, authorizat
| Task | {{site.data.keyword.IBM_notm}} responsibilities | Your responsibilities |
|----------|-----------------------|--------|
|{{site.data.keyword.satelliteshort}} Location | - Provide an interface to assign access control to locations via IAM. | - Use the provided tools to [manage authentication, authorization, and access control policies](/docs/satellite?topic=satellite-iam). |
| {{site.data.keyword.satelliteshort}} Host | - Disable the ability to SSH into hosts after you assign the hosts to a location control plane or cluster, to enhance security. | - [Add](/docs/satellite?topic=satellite-attach-hosts) and [assign](/docs/satellite?topic=satellite-assigning-hosts) hosts to a cluster. After assigning the host, SSH access is disabled and access to the host is controlled via [{{site.data.keyword.cloud_notm}} IAM access](/docs/openshift?topic=openshift-users). |
| {{site.data.keyword.satelliteshort}} Host | - Disable the ability to SSH into hosts after you assign the hosts to a location control plane or cluster, to enhance security. | - [Add](/docs/satellite?topic=satellite-attach-hosts) and [assign](/docs/satellite?topic=satellite-assigning-hosts) hosts to a cluster. After assigning the host, SSH access is disabled and access to the host is controlled via [{{site.data.keyword.cloud_notm}} IAM access](/docs/openshift?topic=openshift-iam-platform-access-roles). |
|{{site.data.keyword.satelliteshort}} Config| - Provide an interface to assign access control to configurations via IAM. | - Use the provided tools to [manage authentication, authorization, and access control policies](/docs/satellite?topic=satellite-iam) to use {{site.data.keyword.satelliteshort}} configurations and subscriptions to create, update, and delete Kubernetes resources. Note that access in IAM to {{site.data.keyword.satelliteshort}} Config does not give users access to the clusters, nor the ability to log in and manage the Kubernetes resources from the cluster. Users with access to a cluster might log in and manually change the Kubernetes resources. |
|{{site.data.keyword.satelliteshort}} Link | - Provide an interface to assign access control to endpoints via IAM. | - Use the provided tools to [manage authentication, authorization, and access control policies](/docs/satellite?topic=satellite-iam). |
| {{site.data.keyword.satelliteshort}} Storage | N/A | - Decide and configure read and write access to storage for your apps by using persistent volumes and persistent volume claims. |
Expand Down
2 changes: 1 addition & 1 deletion sitemap.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

copyright:
years: 2017, 2024
lastupdated: "2024-03-28"
lastupdated: "2024-04-11"

keywords: satellite, sitemap
subcollection: satellite
Expand Down
4 changes: 2 additions & 2 deletions tenancy-model.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

copyright:
years: 2022, 2024
lastupdated: "2024-01-03"
lastupdated: "2024-04-11"

keywords: satellite, hybrid, multicloud, tenancy, resellers, satellite reseller, satellite use case

Expand Down Expand Up @@ -251,7 +251,7 @@ Follow the steps to [create an API that can be used in your client account](/doc
### Setting up cluster admin and developer roles
{: #create-roles-tenancy}
Follow the steps to set up the [cluster roles your client needs](/docs/openshift?topic=openshift-users#example-iam).
Follow the steps to set up the [cluster roles your client needs](/docs/openshift?topic=openshift-iam-platform-access-roles#example-iam).
Expand Down

0 comments on commit f55bbdb

Please sign in to comment.