|
| 1 | +:_content-type: ASSEMBLY |
| 2 | +[id="openshift-overview"] |
| 3 | += Overview |
| 4 | +include::modules/common-attributes.adoc[] |
| 5 | +:context: openshift-overview |
| 6 | + |
| 7 | +toc::[] |
| 8 | + |
| 9 | +{product-title} is a cloud-based Kubernetes container platform. The foundation of {product-title} is based on Kubernetes and therefore shares the same technology. It is designed to allow applications and the data centers that support them to expand from just a few machines and applications to thousands of machines that serve millions of clients. |
| 10 | + |
| 11 | +{product-title} enables you to do the following: |
| 12 | + |
| 13 | +* Provide developers and IT organizations with cloud application platforms that can be used for deploying applications on secure and scalable resources. |
| 14 | +* Require minimal configuration and management overhead. {product-title} is built on Kubernetes. |
| 15 | +* Bring Kubernetes platform to customer data centers and cloud. |
| 16 | +* Meet security, privacy, compliance, and governance requirements. |
| 17 | +
|
| 18 | +With its foundation in Kubernetes, {product-title} incorporates the same technology that serves as the engine for massive telecommunications, streaming video, gaming, banking, and other applications. Its implementation in open Red Hat technologies lets you extend your containerized applications beyond a single cloud to on-premise and multi-cloud environments. |
| 19 | + |
| 20 | +include::modules/getting-started-openshift-common-terms.adoc[leveloffset=+1] |
| 21 | + |
| 22 | +[id="openshift-overview-install-openshift"] |
| 23 | +== Installing {product-title} |
| 24 | + |
| 25 | +The {product-title} installation program offers you flexibility. You can use the installation program to deploy a cluster on infrastructure that the installation program provisions and the cluster maintains or deploy a cluster on infrastructure that you prepare and maintain. |
| 26 | + |
| 27 | +For more information about the installation process is, the supported platforms, and choosing a method of installing and preparing your cluster, see the following: |
| 28 | + |
| 29 | +* xref:../installing/index.adoc#installation-overview_ocp-installation-overview[OpenShift Container Platform installation overview] |
| 30 | +* xref:../installing/index.adoc#installation-process_ocp-installation-overview[Installation overview] |
| 31 | +* xref:../installing/index.adoc#supported-platforms-for-openshift-clusters_ocp-installation-overview[Supported platforms for OpenShift Container Platform clusters] |
| 32 | +* xref:../installing/installing-preparing.adoc#installing-preparing-selecting-cluster-type[Selecting a cluster installation type] |
| 33 | + |
| 34 | +[id="openshift-next-steps"] |
| 35 | +== Next Steps |
| 36 | +=== For developers |
| 37 | +Develop and deploy containerized applications with {product-title}. {product-title} is a platform for developing and deploying containerized applications. {product-title} documentation helps you: |
| 38 | + |
| 39 | +* **xref:../architecture/understanding-development.adoc#understanding-development[Understand {product-title} development]**: Learn the different types of containerized applications, from simple containers to advanced Kubernetes deployments and Operators. |
| 40 | + |
| 41 | +* **xref:../applications/projects/working-with-projects.adoc#working-with-projects[Work with projects]**: Create projects from the {product-title} web console or OpenShift CLI (`oc`) to organize and share the software you develop. |
| 42 | + |
| 43 | +* **xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Work with applications]**: |
| 44 | +Use the xref:../web_console/odc-about-developer-perspective.adoc#odc-about-developer-perspective[*Developer* perspective] in the {product-title} web console to |
| 45 | +xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[create and deploy applications]. |
| 46 | +Use the |
| 47 | +xref:../applications/odc-viewing-application-composition-using-topology-view.adoc#odc-viewing-application-composition-using-topology-view[*Topology* view] |
| 48 | +to see your applications, monitor status, connect and group components, and modify your code base. |
| 49 | + |
| 50 | +* ** xref:../cli_reference/developer_cli_odo/understanding-odo.adoc#understanding-odo[Use the developer CLI tool (`odo`)]**: |
| 51 | +The `odo` CLI tool lets developers create single or multi-component applications and automates deployment, build, and service route configurations. It abstracts complex Kubernetes and {product-title} concepts, allowing you to focus on developing your applications. |
| 52 | + |
| 53 | +* **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. |
| 54 | +They use standard Tekton custom resources to automate deployments and are designed for decentralized teams working on microservices-based architecture. |
| 55 | + |
| 56 | +* **Deploy Helm charts**: |
| 57 | +xref:../applications/working_with_helm_charts/understanding-helm.adoc#understanding-helm[Helm 3] |
| 58 | +is a package manager that helps developers define, install, and update |
| 59 | +application packages on Kubernetes. A Helm chart is a packaging format that |
| 60 | +describes an application that can be deployed using the Helm CLI. |
| 61 | + |
| 62 | +* **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 (Git repositories, local binary inputs, and external artifacts). Then, follow examples of build types from basic builds to advanced builds. |
| 63 | + |
| 64 | +* **xref:../openshift_images/create-images.adoc#create-images[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. |
| 65 | + |
| 66 | +* **xref:../applications/deployments/what-deployments-are.adoc#what-deployments-are[Create deployments]**: Use `Deployment` and `DeploymentConfig` objects to exert fine-grained management over applications. |
| 67 | + xref:../applications/deployments/managing-deployment-processes.adoc#deployment-operations[Manage deployments] using the *Workloads* page or OpenShift CLI (`oc`). Learn xref:../applications/deployments/deployment-strategies.adoc#deployment-strategies[rolling, recreate, and custom] deployment strategies. |
| 68 | + |
| 69 | +* **xref:../openshift_images/using-templates.adoc#using-templates[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. |
| 70 | + |
| 71 | +* **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. |
| 72 | + |
| 73 | +* **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 |
| 74 | +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. |
| 75 | + |
| 76 | +* **xref:../rest_api/index.adoc#api-index[REST API reference]**: Learn about {product-title} application programming interface endpoints. |
| 77 | + |
| 78 | +=== For administrators |
| 79 | +* **xref:../architecture/architecture.adoc#architecture-overview-architecture[Understand {product-title} management]**: Learn about components |
| 80 | +of the {product-title} {product-version} control plane. See how {product-title} control plane and worker nodes are managed and updated through the xref:../machine_management/creating_machinesets/creating-machineset-aws.adoc#machine-api-overview_creating-machineset-aws[Machine API] and xref:../architecture/control-plane.adoc#operators-overview_control-plane[Operators]. |
| 81 | + |
| 82 | +* **xref:../authentication/understanding-authentication.adoc#understanding-authentication[Manage users and groups]**: Add users and groups with different levels of permissions to use or modify clusters. |
| 83 | + |
| 84 | +* **xref:../authentication/understanding-authentication.adoc#understanding-authentication[Manage authentication]**: Learn how user, group, and API authentication |
| 85 | +works in {product-title}. {product-title} supports multiple identity providers. |
| 86 | + |
| 87 | +* **xref:../networking/understanding-networking.adoc#understanding-networking[Manage networking]**: The cluster network in {product-title} is managed by the xref:../networking/cluster-network-operator.adoc#cluster-network-operator[Cluster Network Operator] (CNO). The CNO uses iptables rules in xref:../networking/openshift_sdn/configuring-kube-proxy.adoc#configuring-kube-proxy[kube-proxy] to direct traffic between nodes and pods running on those nodes. The Multus Container Network Interface adds the capability to attach xref:../networking/multiple_networks/understanding-multiple-networks.adoc#understanding-multiple-networks[multiple network interfaces] to a pod. Using |
| 88 | +xref:../networking/network_policy/about-network-policy.adoc#about-network-policy[network policy] features, you can isolate your pods or permit selected traffic. |
| 89 | + |
| 90 | +* **xref:../storage/understanding-persistent-storage.adoc#understanding-persistent-storage[Manage storage]**: {product-title} allows cluster administrators to configure persistent storage. |
| 91 | + |
| 92 | +* **xref:../operators/understanding/olm-understanding-operatorhub.adoc#olm-understanding-operatorhub[Manage Operators]**: Lists of Red Hat, ISV, and community Operators can |
| 93 | +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], xref:../operators/admin/olm-upgrading-operators.adoc#olm-upgrading-operators[upgrade], back up, or otherwise manage the Operator on your cluster. |
| 94 | + |
| 95 | +* **xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-extending-api-with-crds[Use custom resource definitions (CRDs) to modify the cluster]**: Cluster features implemented with Operators can be modified with CRDs. Learn to xref:../operators/understanding/crds/crd-extending-api-with-crds.adoc#crd-creating-custom-resources-definition_crd-extending-api-with-crds[create a CRD] and xref:../operators/understanding/crds/crd-managing-resources-from-crds.adoc#crd-managing-resources-from-crds[manage resources from CRDs]. |
| 96 | + |
| 97 | +* **xref:../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[Set resource quotas]**: Choose from CPU, memory, and other system resources to xref:../applications/quotas/quotas-setting-per-project.adoc#quotas-setting-per-project[set quotas]. |
| 98 | + |
| 99 | +* **xref:../applications/pruning-objects.adoc#pruning-objects[Prune and reclaim resources]**: Reclaim space by pruning unneeded Operators, groups, deployments, builds, images, registries, and cron jobs. |
| 100 | + |
| 101 | +* **xref:../scalability_and_performance/scaling-cluster-monitoring-operator.adoc#scaling-cluster-monitoring-operator[Scale] and xref:../scalability_and_performance/using-node-tuning-operator.adoc#using-node-tuning-operator[tune] clusters**: Set cluster limits, tune nodes, scale cluster monitoring, and optimize networking, storage, and routes for your environment. |
| 102 | + |
| 103 | +* **xref:../updating/installing-update-service.adoc#installing-update-service[Understanding the OpenShift Update Service]**: Learn about installing and managing a local OpenShift Update Service for recommending {product-title} updates in restricted network environments. |
| 104 | + |
| 105 | +* **xref:../monitoring/monitoring-overview.adoc#monitoring-overview[Monitor clusters]**: |
| 106 | +Learn to xref:../monitoring/configuring-the-monitoring-stack.adoc#configuring-the-monitoring-stack[configure the monitoring stack]. |
| 107 | +After configuring monitoring, use the web console to access xref:../monitoring/reviewing-monitoring-dashboards.adoc#reviewing-monitoring-dashboards[monitoring dashboards]. In addition to infrastructure metrics, you can also scrape and view metrics for your own services. |
| 108 | + |
| 109 | +* **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]. |
0 commit comments