You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the official {product-title}{product-version} documentation, where you can learn about {product-title} and start exploring its features.
8
8
9
+
ifndef::openshift-rosa,openshift-dedicated[]
9
10
To navigate the {product-title}{product-version} documentation, you can use one of the following methods:
10
11
11
12
* Use the left navigation bar to browse the documentation.
12
13
* Select the task that interests you from the contents of this Welcome page.
14
+
endif::openshift-rosa,openshift-dedicated[]
15
+
16
+
ifdef::openshift-rosa[]
17
+
To navigate the {product-title} (ROSA) documentation, use the left navigation bar.
18
+
19
+
For documentation that is not ROSA-specific, see the link:https://docs.openshift.com/container-platform/4.7/welcome/index.html[OpenShift Container Platform documentation].
20
+
endif::[]
21
+
22
+
ifdef::openshift-dedicated[]
23
+
To navigate the {product-title} documentation, use the left navigation bar.
24
+
25
+
For documentation that is not specific to {product-title}, see the link:https://docs.openshift.com/container-platform/4.7/welcome/index.html[OpenShift Container Platform documentation].
Start with **xref:../architecture/architecture.adoc#architecture-overview-architecture[Architecture]**.
25
39
endif::[]
26
40
@@ -35,10 +49,14 @@ You can also deploy a cluster on AWS infrastructure that you provisioned yoursel
35
49
36
50
- **xref:../installing/installing_azure/installing-azure-account.adoc#installing-azure-account[Install a cluster on Azure]**: You can deploy clusters with xref:../installing/installing_azure/installing-azure-default.adoc#installing-azure-default[default settings], xref:../installing/installing_azure/installing-azure-customizations.adoc#installing-azure-customizations[custom Azure settings], or xref:../installing/installing_azure/installing-azure-network-customizations.adoc#installing-azure-network-customizations[custom networking settings] in Microsoft Azure. You can also provision {product-title} into an xref:../installing/installing_azure/installing-azure-vnet.adoc#installing-azure-vnet[Azure Virtual Network] or use xref:../installing/installing_azure/installing-azure-user-infra.adoc#installing-azure-user-infra[Azure Resource Manager Templates] to provision your own infrastructure.
37
51
52
+
- **xref:../installing/installing_azure_stack_hub/preparing-to-install-on-azure-stack-hub.adoc#preparing-to-install-on-azure-stack-hub[Install a cluster on Azure Stack Hub]**: You can install {product-title} on Azure Stack Hub on user-provisioned infrastructure.
53
+
38
54
- **xref:../installing/installing_gcp/installing-gcp-account.adoc#installing-gcp-account[Install a cluster on GCP]**: You can deploy clusters with xref:../installing/installing_gcp/installing-gcp-default.adoc#installing-gcp-default[default settings] or xref:../installing/installing_gcp/installing-gcp-customizations.adoc#installing-gcp-customizations[custom GCP settings] on Google Cloud Platform (GCP). You can also perform a GCP installation where you provision your own infrastructure.
39
55
40
56
- **xref:../installing/installing_vsphere/installing-vsphere-installer-provisioned.adoc#installing-vsphere-installer-provisioned[Install a cluster on VMware vSphere]**: You can install {product-title} on supported versions of vSphere.
41
57
58
+
- **xref:../installing/installing_vmc/preparing-to-install-on-vmc.adoc#preparing-to-install-on-vmc[Install a cluster on VMware Cloud]**: You can install OpenShift Container Platform on supported versions of VMware Cloud (VMC) on AWS.
59
+
42
60
ifndef::openshift-origin[]
43
61
- **xref:../installing/installing_ibm_z/installing-ibm-z.adoc#installing-ibm-z[Install a cluster with z/VM on IBM Z and LinuxONE]**: You can install {product-title} with z/VM on IBM Z and LinuxONE on user-provisioned infrastructure.
44
62
@@ -52,7 +70,9 @@ endif::openshift-origin[]
52
70
- **xref:../installing/installing_bare_metal/installing-bare-metal.adoc#installing-bare-metal[Install a user-provisioned cluster on bare metal]**: If none of the available platform and cloud provider deployment options meet your needs, you can install {product-title} on user-provisioned bare metal infrastructure.
53
71
54
72
- **Install a cluster on {rh-openstack-first}**: You can install a cluster on
55
-
xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[{rh-openstack} with customizations].
73
+
xref:../installing/installing_openstack/installing-openstack-installer-custom.adoc#installing-openstack-installer-custom[{rh-openstack} with customizations], with xref:../installing/installing_openstack/installing-openstack-installer-kuryr.adoc#installing-openstack-installer-kuryr[network customizations], or xref:../installing/installing_openstack/installing-openstack-installer-restricted.adoc#installing-openstack-installer-restricted[on a restricted network] on installer-provisioned infrastructure.
74
+
+
75
+
You can install a cluster on xref:../installing/installing_openstack/installing-openstack-user.adoc#installing-openstack-user[{rh-openstack} with customizations], xref:../installing/installing_openstack/installing-openstack-user-kuryr.adoc#installing-openstack-user-kuryr[with network customizations], or xref:../installing/installing_openstack/installing-openstack-user-sr-iov.adoc#installing-openstack-user-sr-iov[with SR-IOV] on user-provisioned infrastructure.
56
76
57
77
////
58
78
You can configure an external load balancer for
@@ -109,6 +129,7 @@ Internet access is still required to access the cloud APIs and installation medi
109
129
- **xref:../storage/persistent_storage/persistent-storage-ocs.adoc#red-hat-openshift-container-storage[Install Red Hat OpenShift Container Storage]**: You can install Red Hat OpenShift Container Storage as an Operator to provide highly integrated and simplified persistent storage management for containers.
110
130
endif::[]
111
131
132
+
ifndef::openshift-rosa,openshift-dedicated[]
112
133
== Developer activities
113
134
Develop and deploy containerized applications with {product-title}. {product-title} is a platform for developing and deploying containerized applications. {product-title} documentation helps you:
114
135
@@ -129,15 +150,11 @@ to see your applications, monitor status, connect and group components, and modi
129
150
The `odo` CLI tool lets developers create single or multi-component applications easily and automates deployment, build, and service route configurations. It abstracts complex Kubernetes and {product-title} concepts, allowing you to focus on developing your applications.
130
151
131
152
- **xref:../cicd/pipelines/understanding-openshift-pipelines.adoc#op-key-features[Create CI/CD Pipelines]**: Pipelines are serverless, cloud-native, continuous integration and continuous deployment systems that run in isolated containers.
132
-
They use standard Tekton custom resources to automate deployments and are designed for decentralized teams that work on microservices-based architecture.
153
+
They use standard Tekton custom resources to automate deployments and are designed for decentralized teams that work on microservice-based architecture.
is a package manager that helps developers define, install, and update
138
-
application packages on Kubernetes. A Helm chart is a packaging format that
139
-
describes an application that can be deployed using the Helm CLI.
140
-
endif::[]
157
+
xref:../applications/working_with_helm_charts/understanding-helm.adoc#understanding-helm[Helm] is a software package manager that simplifies deployment of applications and services to OpenShift Container Platform clusters. Helm uses a packaging format called charts. A Helm chart is a collection of files that describes the OpenShift Container Platform resources.
141
158
142
159
- **xref:../cicd/builds/understanding-image-builds.adoc#understanding-image-builds[Understand image builds]**: Choose from different build strategies (Docker, S2I, custom, and pipeline) that can include different kinds of source materials (from places like Git repositories, local binary inputs, and external artifacts). Then, follow examples of build types from basic builds to advanced builds.
143
160
@@ -150,12 +167,39 @@ endif::[]
150
167
151
168
- **xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Understand Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title}{product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.
- **xref:../operators/operator_sdk/osdk-about.adoc#osdk-about[Develop Operators]**: Operators are the preferred method for creating on-cluster applications for {product-title}{product-version}. Learn the workflow for building, testing, and deploying Operators. Then, create your own Operators based on xref:../operators/operator_sdk/ansible/osdk-ansible-support.adoc#osdk-ansible-support[Ansible] or
155
171
xref:../operators/operator_sdk/helm/osdk-helm-support.adoc#osdk-helm-support[Helm], or configure xref:../operators/operator_sdk/osdk-monitoring-prometheus.adoc#osdk-monitoring-prometheus[built-in Prometheus monitoring] using the Operator SDK.
156
172
157
173
- **xref:../rest_api/index.adoc#api-index[REST API reference]**: Learn about {product-title} application programming interface endpoints.
158
174
endif::[]
175
+
endif::[]
176
+
177
+
ifdef::openshift-rosa,openshift-dedicated[]
178
+
== Developer activities
179
+
Ultimately, {product-title} is a platform for developing and deploying containerized applications. As an application developer, {product-title} and OpenShift Container Platform documentation helps you:
180
+
181
+
- *Understand {product-title} development*: Learn the different types of containerized applications, from simple containers to advanced Kubernetes deployments and Operators.
182
+
183
+
- *Work with projects*: Create projects from the web console or CLI to organize and share the software you develop.
184
+
185
+
- *Work with applications*: Use the Developer perspective in the {product-title} web console to easily create and deploy applications. Use the Topology view to visually interact with your applications, monitor status, connect and group components, and modify your code base.
186
+
187
+
- *Use the developer CLI tool (odo)*: The odo CLI tool lets developers create single or multi-component applications easily and automates deployment, build, and service route configurations.
188
+
It abstracts complex Kubernetes and {product-title} concepts, allowing developers to focus on developing their applications.
189
+
190
+
- *Create CI/CD Pipelines*: Pipelines are serverless, cloud-native, continuous integration and continuous deployment systems that run in isolated containers. They use standard Tekton custom resources to automate deployments and are designed for decentralized teams that work on microservices-based architecture.
191
+
192
+
- *Understand Operators*: Operators are the preferred method for creating on-cluster applications for {product-title}{product-version}. Learn about the Operator Framework and how to deploy applications using installed Operators into your projects.
193
+
194
+
- *Understand image builds*: Choose from different build strategies (Docker, S2I, custom, and pipeline) that can include different kinds of source materials (from places like Git repositories, local binary inputs, and external artifacts). Then, follow examples of build types from basic builds to advanced builds.
195
+
196
+
- *Create container images*: A container image is the most basic building block in {product-title} (and Kubernetes) applications. Defining image streams lets you gather multiple versions of an image in one place as you continue its development. S2I containers let you insert your source code into a base container that is set up to run code of a particular type (such as Ruby, Node.js, or Python).
197
+
198
+
- *Create deployments*: Use `Deployment` and `DeploymentConfig` objects to exert fine-grained management over applications.
199
+
Use the Workloads page or `oc` CLI to manage deployments. Learn rolling, recreate, and custom deployment strategies.
200
+
201
+
- *Create templates*: Use existing templates or create your own templates that describe how an application is built or deployed. A template can combine images with descriptions, parameters, replicas, exposed ports and other content that defines how an application can be run or built.
@@ -244,47 +288,13 @@ After configuring monitoring, use the web console to access xref:../monitoring/r
244
288
- **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster. Using Telemetry and the Insights Operator, this data is received by Red Hat and used to improve {product-title}. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
245
289
endif::[]
246
290
247
-
ifdef::openshift-dedicated[]
291
+
ifdef::openshift-rosa,openshift-dedicated[]
248
292
== Cluster administrator activities
249
293
250
-
While cluster maintenance and host configuration is performed by the {product-title}
251
-
Operations Team, other ongoing tasks on your {product-title} {product-version}
252
-
cluster can be performed by {product-title} cluster administrators. As a
253
-
{product-title} cluster administrator, this documentation helps you:
254
-
255
-
- **xref:../administering_a_cluster/dedicated-admin-role.adoc#dedicated-administrator-role[Understand the `dedicated-admin` role]**: Learn about the elevated privileges provided to {product-title} cluster administrators.
256
-
257
-
////
258
-
- **xref:../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can
259
-
be reviewed by cluster administrators and xref:../operators/admin/olm-adding-operators-to-cluster.adoc#olm-adding-operators-to-a-cluster[installed on their clusters]. After you install them, you can xref:../operators/user/olm-creating-apps-from-installed-operators.adoc#olm-creating-apps-from-installed-operators[run], upgrade, back up or otherwise manage the Operator on your cluster (based on what the Operator is designed to do).
260
-
////
261
-
262
-
- **xref:../administering_a_cluster/dedicated-admin-role.adoc#dedicated-managing-administrators_dedicated-administrator[Manage RBAC authorizations]**: Grant permissions to users or groups and manage service accounts.
- **xref:../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[Set resource quotas]**: Choose from CPU, memory and other system resources to set quotas.
294
+
While cluster maintenance and host configuration is performed by the Red Hat Site Reliability Engineering (SRE) team, other ongoing tasks on your {product-title} {product-version} cluster can be performed by {product-title} cluster administrators. As an {product-title} cluster administrator, the documentation helps you:
267
295
268
-
endif::[]
269
-
270
-
////
271
-
- **xref:../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[Manage resources from Custom Resource Definition (CRDs)]**: Learn about how {product-title} cluster administrators and project administrators can use CRDs to manage custom resources in non-default namespaces.
272
-
////
273
-
274
-
275
-
////
276
-
- **xref:../applications/pruning-objects.adoc#pruning-objects[Prune and reclaim resources]**: You can reclaim spaceby pruning unneeded Operators, groups, deployments, builds, images, registries, and cron jobs.
277
-
278
-
- **xref:../logging/cluster-logging.adoc#cluster-logging[Work with OpenShift Logging]**:
279
-
Learn about how to deploy and use a cluster to aggregate logs for a range of {product-title}
280
-
services. OpenShift Logging collects, stores, and visualizes logging data from hosts and
281
-
applications, whether coming from multiple containers or even deleted pods.
282
-
283
-
- **xref:../monitoring/understanding-the-monitoring-stack.adoc#understanding-the-monitoring-stack[Monitor clusters]**: Learn to
284
-
xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack].
285
-
Once your monitoring is configured, use the web UI to xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards].
286
-
In addition to infrastructure metrics, you can also scrape and view metrics for your own services.
287
-
288
-
- **xref:../support/remote_health_monitoring/about-remote-health-monitoring.adoc#about-remote-health-monitoring_about-remote-health-monitoring[Remote health monitoring]**: {product-title} collects anonymized aggregated information about your cluster and reports it to Red Hat via Telemetry and the Insights Operator. This information allows Red Hat to improve {product-title} and to react to issues that impact customers more quickly. You can view the xref:../support/remote_health_monitoring/showing-data-collected-by-remote-health-monitoring.adoc#showing-data-collected-by-remote-health-monitoring_showing-data-collected-by-remote-health-monitoring[data collected by remote health monitoring].
289
-
////
296
+
- *Manage Dedicated Administrators*: Grant or revoke permissions to `dedicated admin` users.
297
+
- *Work with Logging*: Learn about {product-title} Logging and configure the logging add-on services.
298
+
- *Monitor clusters*: Learn to use the Web UI to access monitoring dashboards.
299
+
- *Manage nodes*: Learn to manage nodes, including configuring machine pools and autoscaling.
0 commit comments