1
0
mirror of https://github.com/openshift/openshift-docs.git synced 2026-02-05 12:46:18 +01:00
Files
openshift-docs/osd_getting_started/osd-getting-started.adoc
2025-10-28 14:54:43 -04:00

98 lines
7.0 KiB
Plaintext

:_mod-docs-content-type: ASSEMBLY
[id="osd-getting-started"]
= Getting started with {product-title}
include::_attributes/attributes-openshift-dedicated.adoc[]
:context: osd-getting-started
toc::[]
[role="_abstract"]
Follow this getting started document to quickly create a {product-title} cluster, grant user access, deploy your first application, and learn how to scale and delete your cluster.
[id="osd-getting-started-prerequisites"]
== Prerequisites
* You reviewed the xref:../osd_architecture/osd-understanding.adoc#osd-understanding[introduction to {product-title}] and the documentation on xref:../architecture/index.adoc#architecture-overview[architecture concepts].
* You reviewed the xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[{product-title} cloud deployment options].
[id="osd-getting-started-create-cluster"]
== Creating an {product-title} cluster
You can install {product-title} in your own cloud provider account through the Customer Cloud Subscription (CCS) model or in a cloud account that is owned by Red Hat. For more information about the deployment options for {product-title}, see xref:../osd_getting_started/osd-understanding-your-cloud-deployment-options.adoc#osd-understanding-your-cloud-deployment-options[Understanding your cloud deployment options].
Choose from one of the following methods to deploy your cluster.
[id="osd-getting-started-create-cluster-gcp-ccs"]
=== Creating a cluster on {gcp-short} using the CCS model
You can install {product-title} in your own {GCP} account by using the CCS model. Complete the steps in one of the following sections to deploy {product-title} in your own {gcp-short} account.
* Red Hat recommends using {gcp-short} Workload Identity Federation (WIF) as the authentication type for installing and interacting with the {product-title} cluster deployed on {gcp-short} because it provides enhanced security. For more information, see xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on {gcp-short} with Workload Identity Federation authentication].
* Red Hat also recommends creating an {product-title} cluster deployed on {gcp-short} in Private cluster mode with Private Service Connect (PSC) to manage and monitor a cluster to avoid all public ingress network traffic. For more information, see xref:../osd_gcp_clusters/creating-a-gcp-psc-enabled-private-cluster.adoc#creating-a-gcp-psc-enabled-private-cluster[Private Service Connect overview].
* For installing and interacting with the {product-title} cluster deployed on {gcp-short} by using the Service Account authentication type, see xref:../osd_gcp_clusters/creating-a-gcp-cluster-sa.adoc#osd-create-gcp-cluster-ccs_osd-creating-a-cluster-on-gcp-sa[Creating a cluster on {gcp-short} with Service Account authentication].
[id="osd-getting-started-create-cluster-aws-ccs"]
=== Creating a cluster on AWS using the CCS model
You can install {product-title} in your own {AWS} account by using the CCS model.
* xref:../osd_aws_clusters/creating-an-aws-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-aws[Creating a cluster on AWS]
[id="osd-getting-started-create-cluster-red-hat-cloud-account"]
=== Creating a cluster using a Red Hat cloud account
Complete the steps in one of the following sections to deploy {product-title} in a cloud account that is owned by Red Hat:
* xref:../osd_gcp_clusters/creating-a-gcp-cluster-redhat-account.adoc#creating-a-gcp-cluster-rh-account[Creating a cluster on {gcp-short} with a Red Hat cloud account]: You can install {product-title} in an {gcp-short} account that is owned by Red Hat.
* xref:../osd_aws_clusters/creating-an-aws-cluster.adoc#osd-create-aws-cluster-red-hat-account_osd-creating-a-cluster-on-aws[Creating a cluster on AWS]: You can install {product-title} in an AWS account that is owned by Red Hat.
// Update link when OSDOCS-12950 goes live.
include::modules/config-idp.adoc[leveloffset=+1]
.Additional resources
* For detailed steps to configure each of the supported identity provider types, see xref:../authentication/sd-configuring-identity-providers.adoc#sd-configuring-identity-providers[Configuring identity providers].
include::modules/osd-grant-admin-privileges.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
* xref:../osd_architecture/osd_policy/osd-service-definition.adoc#cluster-admin-user_osd-service-definition[Customer administrator user]
include::modules/access-cluster.adoc[leveloffset=+1]
include::modules/deploy-app.adoc[leveloffset=+1]
include::modules/scaling-cluster.adoc[leveloffset=+1]
.Additional resources
* For information about machine pools, see xref:../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machine-pools-about[About machine pools].
* For detailed steps to enable autoscaling for compute nodes in your cluster, see xref:../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster].
include::modules/osd-revoke-admin-privileges.adoc[leveloffset=+1]
include::modules/osd-revoke-user-access.adoc[leveloffset=+1]
include::modules/deleting-cluster.adoc[leveloffset=+1]
[id="next-steps_{context}"]
== Next steps
* xref:../adding_service_cluster/adding-service.adoc#adding-service[Adding services to a cluster using the {cluster-manager} console]
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-machinepools-about.adoc#osd-machine-pools-about[About machine pools]
* xref:../osd_cluster_admin/osd_nodes/osd-nodes-about-autoscaling-nodes.adoc#nodes-about-autoscaling-nodes[About autoscaling nodes on a cluster]
* xref:../observability/monitoring/configuring-user-workload-monitoring/preparing-to-configure-the-monitoring-stack-uwm.adoc#preparing-to-configure-the-monitoring-stack-uwm[Preparing to configure the user workload monitoring stack]
[id="additional-resources_{context}"]
== Additional resources
* For information about the end-of-life dates for {product-title} versions, see the xref:../osd_architecture/osd_policy/osd-life-cycle.adoc#osd-life-cycle[{product-title} update life cycle].
* For more information about deploying {product-title} clusters on AWS, see xref:../osd_aws_clusters/creating-an-aws-cluster.adoc#osd-create-aws-cluster-ccs_osd-creating-a-cluster-on-aws[Creating a cluster on AWS].
* For more information about deploying {product-title} clusters on {gcp-short}, see xref:../osd_gcp_clusters/creating-a-gcp-cluster-sa.adoc#osd-creating-a-cluster-on-gcp-sa[Creating a cluster on {gcp-short} with Service Account authentication] and xref:../osd_gcp_clusters/creating-a-gcp-cluster-with-workload-identity-federation.adoc#osd-creating-a-cluster-on-gcp-with-workload-identity-federation[Creating a cluster on {gcp-short} with Workload Identity Federation authentication].
* For documentation on upgrading your cluster, see xref:../upgrading/osd-upgrades.adoc#osd-upgrades[{product-title} cluster upgrades].