openshift/openshift-docs
1
0
Fork 0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Code Issues Releases Activity

OSDOCS-9698

Browse Source
This commit is contained in:
Janelle Neczypor
2024-02-19 13:51:06 -08:00
parent df61179028
commit c4abc21908
10 changed files with 48 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-accessing.adoc
View File

@@ -9,13 +9,13 @@ toc::[]
//rosaworkshop.io content metadata
//Brought into ROSA product docs 2023-11-30
You can connect to your cluster using the command line interface (CLI) or the console user interface (UI).
You can connect to your cluster using the command line interface (CLI) or the {hybrid-console} user interface (UI).
== Accessing your cluster using the CLI
To access the cluster using the CLI, you must have the `oc` CLI installed. If you are following the tutorials, you already installed the `oc` CLI.
. Log in to the link:https://console.redhat.com/openshift[Red Hat console].
. Log in to the {cluster-manager-url}.
. Click your username in the top right corner.
. Click *Copy Login Command*.
+
@@ -61,9 +61,9 @@ rosa-user
. You can now access your cluster.
== Accessing the cluster via the web console
. Log in to the link:https://console.redhat.com/openshift/[Red Hat console].
.. To retrieve the console URL run:
== Accessing the cluster via the {hybrid-console-second}
. Log in to the {cluster-manager-url}.
.. To retrieve the {hybrid-console-second} URL run:
+
[source,terminal]
----
@@ -75,6 +75,6 @@ rosa describe cluster -c <cluster-name> | grep Console
image::cloud-experts-getting-started-accessing-copy-token.png[]
. Enter your user credentials.
. You should be logged in. If you are following the tutorials, you will be a cluster-admin and should see a web console with the *Administrator* panel visible.
. You should be logged in. If you are following the tutorials, you will be a cluster-admin and should see the {hybrid-console-second} webpage with the *Administrator* panel visible.
+
image::cloud-experts-getting-started-accessing-logged.png[]

4
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-admin-rights.adoc
View File

@@ -53,7 +53,7 @@ ID GROUPS
<idp_user_name> cluster-admins
----
. If you are currently logged into the Red Hat console, log out of the console and log back in to the cluster to see a new perspective with the "Administrator Panel". You might need an incognito or private window.
. If you are currently logged into the {hybrid-console}, log out of the console and log back in to the cluster to see a new perspective with the "Administrator Panel". You might need an incognito or private window.
+
image:cloud-experts-getting-started-admin-rights-admin-panel.png[]
@@ -66,7 +66,7 @@ $ oc get all -n openshift-apiserver
== Using the Red Hat OpenShift Cluster Manager UI
. Log in to the link:https://console.redhat.com/openshift[Red Hat OpenShift Cluster Manager console].
. Log in to the {cluster-manager-url}.
. Select your cluster.
. Click the *Access Control* tab.
. Click the *Cluster roles and Access* tab in the sidebar.

16
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-choose-deployment-method.adoc
View File

@@ -9,16 +9,16 @@ toc::[]
//rosaworkshop.io content metadata
//Brought into ROSA product docs 2023-11-16
There are a few different ways to deploy a cluster, and this tutorial outlines each method. You only need to choose one based on your preferences and needs. Use the decision tree below to find the deployment method that best fits your situation.
This tutorial outlines the different ways to deploy a cluster. Choose the deployment method that best fits your preferences and needs.
== Deployment options
For those who are thinking:
If you want:
* "Just tell me the commands I need to run!" - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-cli-guide.adoc#cloud-experts-getting-started-simple-cli-guide[Simple CLI guide]
* "I do not like CLI tools. Give me a user interface!" - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-ui-guide.adoc#cloud-experts-getting-started-simple-ui-guide[Simple UI guide]
* "I need details and want to use a CLI!" - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-cli-guide.adoc#cloud-experts-getting-started-detailed-cli-guide[Detailed CLI guide]
* "I need details and want to use a user interface!" xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-ui.adoc#cloud-experts-getting-started-detailed-ui[Detailed UI guide]
* "I want to experiment with the newest technologies." - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-hcp.adoc#cloud-experts-getting-started-detailed-ui-guide[ROSA with HCP]
* Only the necessary CLI commands - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-cli-guide.adoc#cloud-experts-getting-started-simple-cli-guide[Simple CLI guide]
* A user interface - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-ui-guide.adoc#cloud-experts-getting-started-simple-ui-guide[Simple UI guide]
* The CLI commands with details - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-cli-guide.adoc#cloud-experts-getting-started-detailed-cli-guide[Detailed CLI guide]
* A user interface with details - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-ui.adoc#cloud-experts-getting-started-detailed-ui[Detailed UI guide]
* To experiment with the newest ROSA technologies - xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-hcp.adoc#cloud-experts-getting-started-detailed-ui-guide[ROSA with HCP]
All of the above deployment options work well for this workshop. If you are doing this workshop for the first time, the xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-cli-guide.adoc#cloud-experts-getting-started-simple-cli-guide[Simple CLI guide] is the simplest and recommended method.
All of the above deployment options work well for this tutorial. If you are doing this tutorial for the first time, the xref:../../cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-cli-guide.adoc#cloud-experts-getting-started-simple-cli-guide[Simple CLI guide] is the simplest and recommended method.

40
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-cli-guide.adoc
View File

@@ -263,24 +263,24 @@ See the xref:../../../rosa_install_access_delete_clusters/rosa-sts-interactive-m
+
[source,terminal]
----
Cluster name: **my-rosa-cluster** <br>
OpenShift version: **&lt;choose version&gt;** <br>
External ID (optional): **&lt;leave blank&gt;**<br>
Operator roles prefix: **&lt;accept default&gt;** <br>
Multiple availability zones: **No** <br>
AWS region: **&lt;choose region&gt;** <br>
PrivateLink cluster: **No** <br>
Install into an existing VPC: **No** <br>
Enable Customer Managed key: **No** <br>
Compute nodes instance type: **m5.xlarge** <br>
Enable autoscaling: **No** <br>
Compute nodes: **2** <br>
Machine CIDR: **&lt;accept default&gt;** <br>
Service CIDR: **&lt;accept default&gt;** <br>
Pod CIDR: **&lt;accept default&gt;** <br>
Host prefix: **&lt;accept default&gt;** <br>
Encrypt etcd data (optional): **No** <br>
Disable Workload monitoring: **No** <br>
Cluster name: my-rosa-cluster
OpenShift version: <choose version>
External ID (optional): <leave blank>
Operator roles prefix: <accept default>
Multiple availability zones: No
AWS region: <choose region>
PrivateLink cluster: No
Install into an existing VPC: No
Enable Customer Managed key: No
Compute nodes instance type: m5.xlarge
Enable autoscaling: No
Compute nodes: 2
Machine CIDR: <accept default>
Service CIDR: <accept default>
Pod CIDR: <accept default>
Host prefix: <accept default>
Encrypt etcd data (optional): No
Disable Workload monitoring: No
----
+
.Example output
@@ -417,8 +417,8 @@ rosa list clusters
. Once the state changes to “ready” your cluster is installed.
== Obtaining the console URL
* To obtain the console URL, run the following command:
== Obtaining the {hybrid-console} URL
* To obtain the {hybrid-console-second} URL, run the following command:
+
[source,terminal]
----

2
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-detailed-ui.adoc
View File

@@ -64,7 +64,7 @@ This step tells the OpenShift Cluster Manager what AWS account you want to use w
If you have already associated your AWS accounts, skip this step.
====
. Open the OpenShift Cluster Manager by visiting the Red Hat link:https://console.redhat.com/openshift[console] and logging in to your Red Hat account.
. Open the {hybrid-console} by visiting the {cluster-manager-url} and logging in to your Red Hat account.
. Click *Create Cluster*.

4
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-deploying/cloud-experts-getting-started-simple-ui-guide.adoc
View File

@@ -13,7 +13,7 @@ This page outlines the minimum list of commands to deploy a ROSA cluster using t
[NOTE]
====
While this simple deployment works well for a workshop setting, clusters used in production should be deployed with a more detailed method.
While this simple deployment works well for a tutorial setting, clusters used in production should be deployed with a more detailed method.
====
== Prerequisites
@@ -43,7 +43,7 @@ rosa create ocm-role --mode auto --admin --yes
rosa create user-role --mode auto --yes
----
. Use the link:https://console.redhat.com/openshift/create/rosa/wizard[Red Hat OpenShift Cluster Manager UI] to select your AWS account, cluster options, and begin deployment.
. Use the {cluster-manager-url} to select your AWS account, cluster options, and begin deployment.
. OpenShift Cluster Manager UI displays cluster status.
+

2
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-idp.adoc
View File

@@ -104,4 +104,4 @@ image::cloud-experts-getting-started-idp-org.png[]
image::cloud-experts-getting-started-idp-invite.png[]
. Enter the GitHub ID of the new user, select the correct user, and click *Invite*.
. Once the new user accepts the invitation, they will be able to log in to the ROSA cluster using the console link and their GitHub credentials.
. Once the new user accepts the invitation, they will be able to log in to the ROSA cluster using the {hybrid-console-second} link and their GitHub credentials.

2
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-managing-worker-nodes.adoc
View File

@@ -78,7 +78,7 @@ Default No 2 m5.xlarge us
----
=== Creating a machine pool with the UI
. Log in to the link:https://console.redhat.com/openshift[Red Hat console] and click your cluster.
. Log in to the {cluster-manager-url} and click your cluster.
+
image::cloud-experts-getting-started-managing-ocm-cluster.png[]

10
cloud_experts_tutorials/cloud-experts-getting-started/cloud-experts-getting-started-what-is-rosa.adoc
View File

@@ -73,7 +73,7 @@ ROSA is a managed service which is based on OpenShift Container Platform. You ca
Customers can upgrade to the newest version of OpenShift and use the features from that version of OpenShift. For more information, see xref:../../rosa_architecture/rosa_policy_service_definition/rosa-life-cycle.adoc#rosa-life-cycle-dates_rosa-life-cycle[life cycle dates]. Not all OpenShift features are be available on ROSA. Review the xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-service-definition[Service Definition] for more information.
== Support
You can open a ticket directly from the link:https://console.redhat.com/openshift[Red Hat OpenShift Cluster Manager]. See the xref:../../support/getting-support.adoc#getting-support[ROSA support documentation] for more details about obtaining support.
You can open a ticket directly from the {cluster-manager-url}. See the xref:../../support/getting-support.adoc#getting-support[ROSA support documentation] for more details about obtaining support.
You can also visit the link:http://access.redhat.com/[Red Hat Customer Portal] to search or browse through the Red Hat knowledge base of articles and solutions relating to Red Hat products or submit a support case to Red Hat Support.
@@ -90,7 +90,7 @@ AWS support customers must have a valid AWS support contract
Refer to the xref:../../rosa_architecture/rosa_policy_service_definition/rosa-service-definition.adoc#rosa-sdpolicy-sla_rosa-service-definition[ROSA SLA] page for details.
== Notifications and communication
Red Hat will provide notifications regarding new Red Hat and AWS features, updates, and scheduled maintenance through email and the Red Hat console service log.
Red Hat will provide notifications regarding new Red Hat and AWS features, updates, and scheduled maintenance through email and the {hybrid-console-second} service log.
== Open Service Broker for AWS (OBSA)
You can use OSBA with ROSA. However, the preferred method is the more recent link:https://github.com/aws-controllers-k8s/community[AWS Controller for Kubernetes]. See link:https://aws.amazon.com/partners/servicebroker/[Open Service Broker for AWS] for more information on OSBA.
@@ -158,7 +158,7 @@ ROSA uses the OpenShift OVN-Kubernetes default CNI network provider.
Cluster admins can customize, and deny, cross-namespace on a project basis using NetworkPolicy objects. Refer to xref:../../networking/network_policy/multitenant-network-policy.adoc[Configuring multitenant isolation with network policy] for more information.
== Using Prometheus and Grafana
You can use Prometheus and Grafana to monitor containers and manage capacity using OpenShift User Workload Monitoring. This is a check-box option in the link:https://console.redhat.com/openshift[OpenShift Cluster Manager].
You can use Prometheus and Grafana to monitor containers and manage capacity using OpenShift User Workload Monitoring. This is a check-box option in the {cluster-manager-url}.
== Audit logs output from the cluster control-plane
If the Cluster Logging Operator Add-on has been added to the cluster then audit logs are available through CloudWatch. If it has not, then a support request would allow you to request some audit logs. Small targeted and time-boxed logs can be requested for export and sent to a customer. The selection of audit logs available are at the discretion of SRE in the category of platform security and compliance. Requests for exports of a cluster's entirety of logs will be rejected.
@@ -204,5 +204,5 @@ Ingress can be limited to a PrivateLink for Red Hat SREs and a VPN for customer
** xref:../../rosa_planning/rosa-limits-scalability.adoc#rosa-limits-scalability[Limits and Scalability]
** link:https://red.ht/rosa-roadmap[ROSA roadmap]
* link:https://learn.openshift.com[Learn about OpenShift]
* link:https://console.redhat.com/OpenShift[OpenShift Cluster Manager]
* link:https://support.redhat.com[Red Hat Support]
* {cluster-manager-url}
* link:https://support.redhat.com[Red Hat Support]

4
upgrading/rosa-upgrading.adoc
View File

@@ -18,8 +18,8 @@ Upgrades are manually initiated or automatically scheduled. Red Hat Site Reliabi
There are three methods to upgrade {product-title} (ROSA) clusters:
* Individual upgrades through the ROSA CLI (`rosa`)
* Individual upgrades through the {cluster-manager-url} console
* Recurring upgrades through the {cluster-manager-url} console
* Individual upgrades through the {cluster-manager-url}
* Recurring upgrades through the {cluster-manager-url}
[NOTE]
====