From ee032d1612b91a296ae15553f8e53423b09ef3a0 Mon Sep 17 00:00:00 2001 From: bmcelvee Date: Thu, 16 Jan 2025 16:58:22 -0500 Subject: [PATCH] OSDOCS-12560: Building Application- Classic to HCP breakout --- _topic_maps/_topic_map_rosa_hcp.yml | 80 +++++++++++++++++++ applications/application-health.adoc | 8 +- .../exposing-binding-data-from-a-service.adoc | 4 +- .../getting-started-with-service-binding.adoc | 16 ++-- .../installing-sbo.adoc | 4 +- ...reating-apps-from-installed-operators.adoc | 4 +- ...lications-using-developer-perspective.adoc | 12 +-- .../using-templates.adoc | 4 +- .../managing-deployment-processes.adoc | 4 +- .../route-based-deployment-strategies.adoc | 3 + applications/index.adoc | 8 +- applications/odc-editing-applications.adoc | 12 +-- ...n-metrics-using-developer-perspective.adoc | 14 ++-- ...ation-composition-using-topology-view.adoc | 12 +-- .../projects/working-with-projects.adoc | 8 +- applications/pruning-objects.adoc | 30 +++---- ...guring-custom-helm-chart-repositories.adoc | 32 ++++---- .../installing-helm.adoc | 8 +- .../odc-working-with-helm-releases.adoc | 8 +- .../understanding-helm.adoc | 4 +- 20 files changed, 180 insertions(+), 95 deletions(-) diff --git a/_topic_maps/_topic_map_rosa_hcp.yml b/_topic_maps/_topic_map_rosa_hcp.yml index d7316875fc..f5d89cd194 100644 --- a/_topic_maps/_topic_map_rosa_hcp.yml +++ b/_topic_maps/_topic_map_rosa_hcp.yml @@ -759,6 +759,86 @@ Topics: # - Name: Cluster Operators reference # File: operator-reference --- +Name: Building applications +Dir: applications +Distros: openshift-rosa-hcp +Topics: +- Name: Building applications overview + File: index +- Name: Projects + Dir: projects + Topics: + - Name: Working with projects + File: working-with-projects +# cannot impersonate resource "users" in API group +# - Name: Creating a project as another user +# File: creating-project-other-user + - Name: Configuring project creation + File: configuring-project-creation +- Name: Creating applications + Dir: creating_applications + Topics: + - Name: Creating applications using the Developer perspective + File: odc-creating-applications-using-developer-perspective + - Name: Creating applications from installed Operators + File: creating-apps-from-installed-operators + - Name: Creating applications using the CLI + File: creating-applications-using-cli +- Name: Viewing application composition using the Topology view + File: odc-viewing-application-composition-using-topology-view +# cannot create required namespace +# - Name: Exporting applications +# File: odc-exporting-applications +- Name: Working with Helm charts + Dir: working_with_helm_charts + Topics: + - Name: Understanding Helm + File: understanding-helm + - Name: Installing Helm + File: installing-helm + - Name: Configuring custom Helm chart repositories + File: configuring-custom-helm-chart-repositories + - Name: Working with Helm releases + File: odc-working-with-helm-releases +- Name: Deployments + Dir: deployments + Topics: + - Name: Custom domains for applications + File: rosa-config-custom-domains-applications + - Name: Understanding Deployments and DeploymentConfigs + File: what-deployments-are + - Name: Managing deployment processes + File: managing-deployment-processes + - Name: Using deployment strategies + File: deployment-strategies + - Name: Using route-based deployment strategies + File: route-based-deployment-strategies +- Name: Quotas + Dir: quotas + Topics: + - Name: Resource quotas per project + File: quotas-setting-per-project + - Name: Resource quotas across multiple projects + File: quotas-setting-across-multiple-projects +- Name: Using config maps with applications + File: config-maps +- Name: Monitoring project and application metrics using the Developer perspective + File: odc-monitoring-project-and-application-metrics-using-developer-perspective +- Name: Monitoring application health + File: application-health +- Name: Editing applications + File: odc-editing-applications +- Name: Working with quotas + File: working-with-quotas +- Name: Pruning objects to reclaim resources + File: pruning-objects +- Name: Idling applications + File: idling-applications +- Name: Deleting applications + File: odc-deleting-applications +- Name: Using the Red Hat Marketplace + File: red-hat-marketplace +--- Name: Backup and restore Dir: backup_and_restore Distros: openshift-rosa-hcp diff --git a/applications/application-health.adoc b/applications/application-health.adoc index ecd05107e5..42fefe17fd 100644 --- a/applications/application-health.adoc +++ b/applications/application-health.adoc @@ -22,9 +22,9 @@ include::modules/application-health-configuring.adoc[leveloffset=+1] include::modules/odc-monitoring-application-health-using-developer-perspective.adoc[leveloffset=+1] // cannot add health checks in web console -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-adding-health-checks.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-editing-health-checks.adoc[leveloffset=+1] @@ -32,7 +32,7 @@ include::modules/odc-monitoring-health-checks.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * For details on switching to the *Developer* perspective in the web console, see xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[About the *Developer* perspective]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * For details on adding health checks while creating and deploying an application, see *Advanced Options* in the xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective] section. diff --git a/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc b/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc index c8db686905..4bc0cf51d6 100644 --- a/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc +++ b/applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc @@ -23,7 +23,7 @@ include::modules/sbo-categories-of-exposable-binding-data.adoc[leveloffset=+1] == Additional resources // * link:https://github.com/openshift/console/blob/master/frontend/packages/operator-lifecycle-manager/src/components/descriptors/reference/reference.md[OLM Descriptor Reference]. // When OLM descriptors are supported again, add this additional resource. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Defining cluster service versions (CSVs)]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data]. diff --git a/applications/connecting_applications_to_services/getting-started-with-service-binding.adoc b/applications/connecting_applications_to_services/getting-started-with-service-binding.adoc index 0931cb8555..535314cb29 100644 --- a/applications/connecting_applications_to_services/getting-started-with-service-binding.adoc +++ b/applications/connecting_applications_to_services/getting-started-with-service-binding.adoc @@ -14,30 +14,30 @@ The {servicebinding-title} manages the data plane for workloads and backing serv [discrete] == Prerequisites -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have access to an {product-title} cluster using an account with `cluster-admin` permissions. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have access to an {product-title} cluster using an account with `dedicated-admin` permissions. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have installed the `oc` CLI. * You have installed {servicebinding-title} from OperatorHub. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have installed the 5.1.2 version of the Crunchy Postgres for Kubernetes Operator from OperatorHub using the *v5* Update channel. The installed Operator is available in an appropriate namespace, such as the `my-petclinic` namespace. + [NOTE] ==== You can create the namespace using the `oc create namespace my-petclinic` command. ==== -endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have installed the 5.1.2 version of the Crunchy Postgres for Kubernetes Operator from OperatorHub using the *v5* Update channel. The installed Operator is available in an appropriate project, such as the `my-petclinic` project. + [NOTE] ==== You can create the project using the `oc new-project my-petclinic` command. ==== -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //Creating a PostgreSQL database instance include::modules/sbo-creating-a-postgresql-database-instance.adoc[leveloffset=+1] diff --git a/applications/connecting_applications_to_services/installing-sbo.adoc b/applications/connecting_applications_to_services/installing-sbo.adoc index 9c99bd08db..4d19708106 100644 --- a/applications/connecting_applications_to_services/installing-sbo.adoc +++ b/applications/connecting_applications_to_services/installing-sbo.adoc @@ -16,9 +16,9 @@ You can install {servicebinding-title} on {product-title} 4.7 and later. == Prerequisites * You have access to an {product-title} cluster using an account with `cluster-admin` permissions. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * Your cluster has the xref:../../installing/overview/cluster-capabilities.adoc#operator-marketplace_cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //Installing Service Binding Operator using web console diff --git a/applications/creating_applications/creating-apps-from-installed-operators.adoc b/applications/creating_applications/creating-apps-from-installed-operators.adoc index 7e390fd465..948b895e25 100644 --- a/applications/creating_applications/creating-apps-from-installed-operators.adoc +++ b/applications/creating_applications/creating-apps-from-installed-operators.adoc @@ -13,7 +13,7 @@ have been installed by a cluster administrator. This guide walks developers through an example of creating applications from an installed Operator using the {product-title} web console. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] .Additional resources @@ -21,6 +21,6 @@ ifndef::openshift-rosa,openshift-dedicated[] xref:../../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Operators] guide for more on how Operators work and how the Operator Lifecycle Manager is integrated in {product-title}. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/olm-creating-etcd-cluster-from-operator.adoc[leveloffset=+1] diff --git a/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc b/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc index 0f2b6cb722..aac14ab286 100644 --- a/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc +++ b/applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc @@ -54,23 +54,23 @@ Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virt endif::[] // dedicated-admin cannot install the Serverless or Virtualization operators, cannot create namespace. // xref: ../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator] -ifdef::openshift-rosa,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] Note that the *Pipelines* option is displayed only when the OpenShift Pipelines Operator is installed. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [id="prerequisites_odc-creating-applications-using-developer-perspective"] == Prerequisites To create applications using the *Developer* perspective ensure that: -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have xref:../../web_console/web-console.adoc#web-console[logged in to the web console]. * You have created a project or have access to a project with the appropriate xref:../../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] to create applications and other workloads in {product-title}. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console. // * You have created a project or have access to a project with the appropriate xref: ../../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] to create applications and other workloads in {product-title}. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // dedicated-admin cannot install the Serverless operator. This ifdef should cover this. ifdef::openshift-enterprise,openshift-webscale[] diff --git a/applications/creating_applications/using-templates.adoc b/applications/creating_applications/using-templates.adoc index 007f9b11ec..01fb7298d5 100644 --- a/applications/creating_applications/using-templates.adoc +++ b/applications/creating_applications/using-templates.adoc @@ -25,11 +25,11 @@ include::modules/templates-cli-generating-list-of-objects.adoc[leveloffset=+2] include::modules/templates-modifying-uploaded-template.adoc[leveloffset=+1] // cannot patch resource "templates" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/templates-using-instant-app-quickstart.adoc[leveloffset=+1] include::modules/templates-quickstart.adoc[leveloffset=+2] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/templates-writing.adoc[leveloffset=+1] diff --git a/applications/deployments/managing-deployment-processes.adoc b/applications/deployments/managing-deployment-processes.adoc index 9476174e93..030ba3f103 100644 --- a/applications/deployments/managing-deployment-processes.adoc +++ b/applications/deployments/managing-deployment-processes.adoc @@ -24,12 +24,12 @@ include::modules/deployments-setting-triggers.adoc[leveloffset=+3] include::modules/deployments-setting-resources.adoc[leveloffset=+2] // When the Nodes book is added to ROSA/OSD, check if this link is valid. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] .Additional resources * For more information about resource limits and requests, see xref:../../nodes/clusters/nodes-cluster-resource-configure.adoc#nodes-cluster-resource-configure-about_nodes-cluster-resource-configure[Understanding managing application memory]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/deployments-scaling-manually.adoc[leveloffset=+2] include::modules/deployments-accessing-private-repos.adoc[leveloffset=+2] diff --git a/applications/deployments/route-based-deployment-strategies.adoc b/applications/deployments/route-based-deployment-strategies.adoc index 1bf4b78810..95ae73f43f 100644 --- a/applications/deployments/route-based-deployment-strategies.adoc +++ b/applications/deployments/route-based-deployment-strategies.adoc @@ -34,8 +34,11 @@ include::modules/deployments-blue-green.adoc[leveloffset=+1] include::modules/deployments-ab-testing.adoc[leveloffset=+1] include::modules/deployments-ab-testing-lb.adoc[leveloffset=+2] +ifndef::openshift-rosa-hcp[] +// Remove conditionals when Networking content is in ROSA HCP [role="_additional-resources"] [id="additional-resources_{context}"] == Additional resources * xref:../../networking/routes/route-configuration.adoc#nw-route-specific-annotations_route-configuration[Route-specific annotations]. +endif::[] diff --git a/applications/index.adoc b/applications/index.adoc index a73e2c055a..b909004e1c 100644 --- a/applications/index.adoc +++ b/applications/index.adoc @@ -15,12 +15,12 @@ Using projects, you can organize and manage applications in isolation. You can m After you create the project, you can xref:../applications/projects/working-with-projects.adoc#odc-providing-project-permissions-using-developer-perspective_projects[grant or revoke access to a project] and xref:../applications/projects/working-with-projects.adoc#odc-customizing-available-cluster-roles-using-the-web-console_projects[manage cluster roles] for the users using the Developer perspective. You can also xref:../applications/projects/configuring-project-creation.adoc#configuring-project-creation[edit the project configuration resource] while creating a project template that is used for automatic provisioning of new projects. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] Using the CLI, you can xref:../applications/projects/creating-project-other-user.adoc#creating-project-other-user[create a project as a different user] by impersonating a request to the {product-title} API. When you make a request to create a new project, the {product-title} uses an endpoint to provision the project according to a customizable template. As a cluster administrator, you can choose to xref:../applications/projects/configuring-project-creation.adoc#disabling-project-self-provisioning_configuring-project-creation[prevent an authenticated user group from self-provisioning new projects]. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] As a user with dedicated administrator permissions, you can choose to xref:../applications/projects/configuring-project-creation.adoc#disabling-project-self-provisioning_configuring-project-creation[prevent an authenticated user group from self-provisioning new projects]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [id="working-on-application"] diff --git a/applications/odc-editing-applications.adoc b/applications/odc-editing-applications.adoc index 4ce1d7ae32..9e310a369b 100644 --- a/applications/odc-editing-applications.adoc +++ b/applications/odc-editing-applications.adoc @@ -10,16 +10,16 @@ You can edit the configuration and the source code of the application you create == Prerequisites // When the Authentication book is added to ROSA/OSD, check if this link is valid. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create and modify applications in {product-title}. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed an application on {product-title} using the *Developer* perspective]. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective]. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console and have switched to the *Developer* perspective. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-editing-source-code-using-developer-perspective.adoc[leveloffset=+1] diff --git a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc index 9c143803f6..7f60904673 100644 --- a/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc +++ b/applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc @@ -13,12 +13,12 @@ The *Observe* view in the *Developer* perspective provides options to monitor yo == Prerequisites * You have xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[created and deployed applications on {product-title}]. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have xref:../web_console/web-console.adoc#web-console[logged in to the web console] and have switched to xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective]. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console and have switched to the *Developer* perspective. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1] @@ -28,12 +28,12 @@ include::modules/odc-image-vulnerabilities-breakdown.adoc[leveloffset=+1] include::modules/odc-monitoring-your-app-vulnerabilities.adoc[leveloffset=+1] +ifdef::openshift-rosa,openshift-dedicated[] [role="_additional-resources"] [id="additional-resources-odc-monitoring-project-and-application-metrics-using-developer-perspective"] == Additional resources -ifdef::openshift-rosa,openshift-dedicated[] * xref:../observability/monitoring/monitoring-overview.adoc#monitoring-overview[Monitoring overview] endif::openshift-rosa,openshift-dedicated[] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../observability/monitoring/about-ocp-monitoring/about-ocp-monitoring.adoc#about-ocp-monitoring[About {product-title} monitoring] -endif::openshift-rosa,openshift-dedicated[] \ No newline at end of file +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] \ No newline at end of file diff --git a/applications/odc-viewing-application-composition-using-topology-view.adoc b/applications/odc-viewing-application-composition-using-topology-view.adoc index 4fab3cc591..67f00d2f1b 100644 --- a/applications/odc-viewing-application-composition-using-topology-view.adoc +++ b/applications/odc-viewing-application-composition-using-topology-view.adoc @@ -11,15 +11,15 @@ The *Topology* view in the *Developer* perspective of the web console provides a == Prerequisites To view your applications in the *Topology* view and interact with them, ensure that: -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have xref:../web_console/web-console.adoc#web-console[logged in to the web console]. * You have the appropriate xref:../authentication/using-rbac.adoc#default-roles_using-rbac[roles and permissions] in a project to create applications and other workloads in {product-title}. * You are in xref:../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective]. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console. * You are in the *Developer* perspective. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-viewing-application-topology.adoc[leveloffset=+1] @@ -41,6 +41,6 @@ include::modules/odc-labels-and-annotations-used-for-topology-view.adoc[leveloff == Additional resources * See xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-importing-codebase-from-git-to-create-application_odc-creating-applications-using-developer-perspective[Importing a codebase from Git to create an application] for more information on creating an application from Git. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * See xref:../applications/odc-exporting-applications.adoc#odc-exporting-applications[Exporting applications]. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/applications/projects/working-with-projects.adoc b/applications/projects/working-with-projects.adoc index 5af175685d..6dea112749 100644 --- a/applications/projects/working-with-projects.adoc +++ b/applications/projects/working-with-projects.adoc @@ -12,12 +12,12 @@ isolation from other communities. [NOTE] ==== Projects starting with `openshift-` and `kube-` are -ifndef::openshift-dedicated,openshift-rosa[] +ifndef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] xref:../../authentication/using-rbac.adoc#rbac-default-projects_using-rbac[default projects]. -endif::openshift-dedicated,openshift-rosa[] -ifdef::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] +ifdef::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] default projects. -endif::openshift-dedicated,openshift-rosa[] +endif::openshift-dedicated,openshift-rosa,openshift-rosa-hcp[] These projects host cluster components that run as pods and other infrastructure components. As such, {product-title} does not allow you to create projects starting with `openshift-` or `kube-` using the `oc new-project` command. ifndef::openshift-dedicated[] Cluster administrators can create these projects using the `oc adm new-project` command. diff --git a/applications/pruning-objects.adoc b/applications/pruning-objects.adoc index 9020f9db77..5d08939f25 100644 --- a/applications/pruning-objects.adoc +++ b/applications/pruning-objects.adoc @@ -10,33 +10,34 @@ Over time, API objects created in {product-title} can accumulate in the cluster's etcd data store through normal user operations, such as when building and deploying applications. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] Cluster administrators can periodically prune older versions of objects from the cluster that are no longer required. For example, by pruning images you can delete older images and layers that are no longer in use, but are still taking up disk space. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] A user with the `dedicated-admin` role can periodically prune older versions of objects from the cluster that are no longer required. For example, by pruning images you can delete older images and layers that are no longer in use, but are still taking up disk space. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-basic-operations.adoc[leveloffset=+1] include::modules/pruning-groups.adoc[leveloffset=+1] include::modules/pruning-deployments.adoc[leveloffset=+1] include::modules/pruning-builds.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] [role="_additional-resources"] .Additional resources * xref:../cicd/builds/advanced-build-operations.adoc#builds-build-pruning-advanced-build-operations[Performing advanced builds -> Pruning builds] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-images.adoc[leveloffset=+1] //cannot create resource "serviceaccounts". cannot create resource "cronjobs" -ifndef::openshift-rosa,openshift-dedicated[] + +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-images-manual.adoc[leveloffset=+1] [role="_additional-resources"] @@ -47,23 +48,24 @@ include::modules/pruning-images-manual.adoc[leveloffset=+1] xref:../registry/configuring-registry-operator.adoc#configuring-registry-operator[Image Registry Operator in {product-title}] for information on how to create a registry route. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] // cannot patch resource "configs" -ifndef::openshift-rosa,openshift-dedicated[] + +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-hard-pruning-registry.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/pruning-cronjobs.adoc[leveloffset=+1] [role="_additional-resources"] .Additional resources // When the Operators book is added to ROSA/OSD, check if this link is valid. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs_nodes-nodes-jobs[Running tasks in pods using jobs] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../applications/quotas/quotas-setting-across-multiple-projects.adoc#setting-quotas-across-multiple-projects[Resource quotas across multiple projects] // When the Operators book is added to ROSA/OSD, check if this link is valid. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * xref:../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc b/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc index bdb2b9cb1c..823d7ce3e2 100644 --- a/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc +++ b/applications/working_with_helm_charts/configuring-custom-helm-chart-repositories.adoc @@ -7,12 +7,12 @@ include::_attributes/common-attributes.adoc[] toc::[] [role="_abstract"] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] You can create Helm releases on an {product-title} cluster using the following methods: * The CLI. * The *Developer* perspective of the web console. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] The *Developer Catalog*, in the *Developer* perspective of the web console, displays the Helm charts available in the cluster. By default, it lists the Helm charts from the Red Hat OpenShift Helm chart repository. For a list of the charts, see link:https://charts.openshift.io/index.yaml[the Red Hat `Helm index` file]. @@ -29,39 +29,39 @@ In the *Developer* perspective of the web console, you can use the *Helm* page t * View the list of the existing Helm chart repositories in the Repositories tab, which can also be easily distinguished as either cluster scoped or namespace scoped. // clusterroles.rbac.authorization.k8s.io is forbidden: user (groups=["dedicated-admins" "system:authenticated:oauth" "system:authenticated"]) is attempting to grant RBAC permissions not currently held: -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-installing-a-helm-chart-on-an-openshift-cluster.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-creating-helm-releases-using-developer-perspective.adoc[leveloffset=+1] == Using Helm in the web terminal // ROSA/OSD users can access the web terminal, but the docs are not currently present in the ROSA/OSD books. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] You can use Helm by xref:../../web_console/web_terminal/odc-using-web-terminal.adoc#odc-access-web-terminal_odc-using-web-terminal[Accessing the web terminal] in the *Developer* perspective of the web console. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] You can use Helm by Accessing the web terminal in the *Developer* perspective of the web console. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-creating-a-custom-helm-chart-on-openshift.adoc[leveloffset=+1] //cannot create resource "helmchartrepositories" in API group "helm.openshift.io" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-adding-helm-chart-repositories.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //projecthelmchartrepositories.helm.openshift.io "azure-sample-repo" is forbidden: User cannot get resource "projecthelmchartrepositories" in API group "helm.openshift.io" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-adding-namespace-scoped-helm-chart-repositories.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //cannot create resource "helmchartrepositories" in API group "helm.openshift.io" -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/helm-filtering-helm-charts-by-certification-level.adoc[leveloffset=+1] -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //cannot patch resource "helmchartrepositories" in API group "helm.openshift.io" include::modules/helm-disabling-helm-chart-repositories.adoc[leveloffset=+1] -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] diff --git a/applications/working_with_helm_charts/installing-helm.adoc b/applications/working_with_helm_charts/installing-helm.adoc index e7c65cf495..3ac0a5d8f7 100644 --- a/applications/working_with_helm_charts/installing-helm.adoc +++ b/applications/working_with_helm_charts/installing-helm.adoc @@ -15,7 +15,7 @@ You can also find the URL to the latest binaries from the {product-title} web co == On Linux -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Download the Helm binary and add it to your path: * Linux (x86_64, amd64) @@ -38,15 +38,15 @@ ifndef::openshift-rosa,openshift-dedicated[] ---- # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-ppc64le -o /usr/local/bin/helm ---- -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Download the Linux x86_64 or Linux amd64 Helm binary and add it to your path: + [source,terminal] ---- # curl -L https://mirror.openshift.com/pub/openshift-v4/clients/helm/latest/helm-linux-amd64 -o /usr/local/bin/helm ---- -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] . Make the binary file executable: + diff --git a/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc b/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc index efd04fd76e..351e176692 100644 --- a/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc +++ b/applications/working_with_helm_charts/odc-working-with-helm-releases.adoc @@ -10,12 +10,12 @@ You can use the *Developer* perspective in the web console to update, rollback, == Prerequisites -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console and have switched to xref:../../web_console/web-console-overview.adoc#about-developer-perspective_web-console-overview[the *Developer* perspective]. -endif::openshift-rosa,openshift-dedicated[] -ifdef::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] +ifdef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] * You have logged in to the web console and have switched to the *Developer* perspective. -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] include::modules/odc-upgrading-helm-release.adoc[leveloffset=+1] diff --git a/applications/working_with_helm_charts/understanding-helm.adoc b/applications/working_with_helm_charts/understanding-helm.adoc index 9dc558284e..65ee3b1c07 100644 --- a/applications/working_with_helm_charts/understanding-helm.adoc +++ b/applications/working_with_helm_charts/understanding-helm.adoc @@ -27,12 +27,12 @@ Helm provides the ability to: * Package and share your applications as charts. // No tech preview in ROSA/OSD, added ifndef in case this note gets un-commented. -ifndef::openshift-rosa,openshift-dedicated[] +ifndef::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] //[NOTE] //==== // In {product-title} 4.10 and 4.11, Helm is disabled for the xref: ../../web_console/web-console.adoc#multi-cluster-about_web-console[Multicluster Console] (Technology Preview). //==== -endif::openshift-rosa,openshift-dedicated[] +endif::openshift-rosa,openshift-rosa-hcp,openshift-dedicated[] == Red Hat Certification of Helm charts for OpenShift