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

ocp-rosa-port-applications

This commit is contained in:
Michael Burke
2023-11-06 09:52:08 -05:00
committed by openshift-cherrypick-robot
parent cd047324a6
commit 17edd8f10b
32 changed files with 412 additions and 25 deletions

View File

@@ -781,16 +781,107 @@ Topics:
- Name: Secured routes
File: secured-routes
---
Name: Applications
Name: Building applications
Dir: applications
Distros: openshift-dedicated
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: Connecting applications to services
Dir: connecting_applications_to_services
Topics:
- Name: Service Binding Operator release notes
File: sbo-release-notes
- Name: Understanding Service Binding Operator
File: understanding-service-binding-operator
- Name: Installing Service Binding Operator
File: installing-sbo
- Name: Getting started with service binding
File: getting-started-with-service-binding
# Not applicable to ROSA/OSD
# - Name: Getting started with service binding on IBM Power, IBM Z, and IBM LinuxONE
# File: getting-started-with-service-binding-ibm-power-ibm-z
- Name: Exposing binding data from a service
File: exposing-binding-data-from-a-service
- Name: Projecting binding data
File: projecting-binding-data
- Name: Binding workloads using Service Binding Operator
File: binding-workloads-using-sbo
- Name: Connecting an application to a service using the Developer perspective
File: odc-connecting-an-application-to-a-service-using-the-developer-perspective
- 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
Distros: openshift-dedicated
Topics:
- Name: Custom domains for applications
File: osd-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: Nodes
Dir: nodes

View File

@@ -1008,16 +1008,107 @@ Topics:
- Name: Secured routes
File: secured-routes
---
Name: Application development
Name: Building applications
Dir: applications
Distros: openshift-rosa
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: Connecting applications to services
Dir: connecting_applications_to_services
Topics:
- Name: Service Binding Operator release notes
File: sbo-release-notes
- Name: Understanding Service Binding Operator
File: understanding-service-binding-operator
- Name: Installing Service Binding Operator
File: installing-sbo
- Name: Getting started with service binding
File: getting-started-with-service-binding
# Not applicable to ROSA/OSD
# - Name: Getting started with service binding on IBM Power, IBM Z, and IBM LinuxONE
# File: getting-started-with-service-binding-ibm-power-ibm-z
- Name: Exposing binding data from a service
File: exposing-binding-data-from-a-service
- Name: Projecting binding data
File: projecting-binding-data
- Name: Binding workloads using Service Binding Operator
File: binding-workloads-using-sbo
- Name: Connecting an application to a service using the Developer perspective
File: odc-connecting-an-application-to-a-service-using-the-developer-perspective
- 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
Distros: openshift-rosa
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: Application GitOps workflows
# File: rosa-app-gitops-workflows
# - Name: Application logging

View File

@@ -29,5 +29,7 @@ include::modules/odc-monitoring-health-checks.adoc[leveloffset=+1]
[role="_additional-resources"]
.Additional resources
ifndef::openshift-rosa,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[]
* 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.

View File

@@ -23,5 +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[]
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Defining cluster service versions (CSVs)].
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].
endif::openshift-rosa,openshift-dedicated[]
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].

View File

@@ -14,15 +14,30 @@ The {servicebinding-title} manages the data plane for workloads and backing serv
[discrete]
== Prerequisites
ifndef::openshift-rosa,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[]
* You have access to an {product-title} cluster using an account with `dedicated-admin` permissions.
endif::openshift-rosa,openshift-dedicated[]
* You have installed the `oc` CLI.
* You have installed {servicebinding-title} from OperatorHub.
ifndef::openshift-rosa,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[]
* 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[]
//Creating a PostgreSQL database instance
include::modules/sbo-creating-a-postgresql-database-instance.adoc[leveloffset=+1]
@@ -39,4 +54,4 @@ include::modules/sbo-connecting-spring-petclinic-sample-app-to-postgresql-databa
* xref:../../applications/connecting_applications_to_services/installing-sbo.adoc#installing-sbo[Installing Service Binding Operator].
* xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
* xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc[Managing resources from custom resource definitions].
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].

View File

@@ -16,8 +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[]
* Your cluster has the xref:../../post_installation_configuration/enabling-cluster-capabilities.adoc#enabling-cluster-capabilities[Marketplace capability] enabled or the Red Hat Operator catalog source configured manually.
endif::openshift-rosa,openshift-dedicated[]
//Installing Service Binding Operator using web console
@@ -25,4 +26,4 @@ include::modules/op-installing-sbo-operator-using-the-web-console.adoc[leveloffs
== Additional Resources
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].

View File

@@ -13,6 +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[]
[role="_additional-resources"]
.Additional resources
@@ -20,5 +21,6 @@ installed Operator using the {product-title} web console.
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[]
include::modules/olm-creating-etcd-cluster-from-operator.adoc[leveloffset=+1]

View File

@@ -52,15 +52,27 @@ The Managed services option is also available if the RHOAS Operator is installed
ifdef::openshift-enterprise,openshift-webscale[]
Note that certain options, such as *Pipelines*, *Event Source*, and *Import Virtual Machines*, are displayed only when the link:https://docs.openshift.com/pipelines/latest/install_config/installing-pipelines.html#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator], link:https://docs.openshift.com/serverless/1.28/install/install-serverless-operator.html#serverless-install-web-console_install-serverless-operator[{ServerlessOperatorName}], and xref:../../virt/install/installing-virt.adoc#virt-subscribing-cli_installing-virt[OpenShift Virtualization Operator] are installed, respectively.
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[]
Note that the *Pipelines* option is displayed only when the OpenShift Pipelines Operator is installed.
endif::openshift-rosa,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[]
* 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[]
* 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[]
// dedicated-admin cannot install the Serverless operator. This ifdef should cover this.
ifdef::openshift-enterprise,openshift-webscale[]
To create serverless applications, in addition to the preceding prerequisites, ensure that:

View File

@@ -23,10 +23,13 @@ include::modules/deployments-triggers.adoc[leveloffset=+2]
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[]
[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[]
include::modules/deployments-scaling-manually.adoc[leveloffset=+2]
include::modules/deployments-accessing-private-repos.adoc[leveloffset=+2]

View File

@@ -15,7 +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-developer-perspective_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[]
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[]
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[]
[id="working-on-application"]
== Working on an application
@@ -30,13 +35,16 @@ You can also use components that include source or binary code, images, and temp
[id="maintaining-application"]
=== Maintaining an application
After you create the application you can use the web console to xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#odc-monitoring-project-and-application-metrics-using-developer-perspective[monitor your project or application metrics]. You can also xref:../applications/odc-editing-applications.adoc#odc-editing-applications[edit] or xref:../applications/odc-deleting-applications.adoc#odc-deleting-applications[delete] the application using the web console.
After you create the application you can use the web console to xref:../applications/odc-monitoring-project-and-application-metrics-using-developer-perspective.adoc#odc-monitoring-project-and-application-metrics-using-developer-perspective[monitor your project or application metrics]. You can also xref:../applications/odc-editing-applications.adoc#odc-editing-applications[edit] or xref:../applications/odc-deleting-applications.adoc#odc-deleting-applications[delete] the application using the web console.
When the application is running, not all applications resources are used. As a cluster administrator, you can choose to xref:../applications/idling-applications.adoc#idling-applications[idle these scalable resources] to reduce resource consumption.
[id="connecting-application"]
=== Connecting an application to services
An application uses backing services to build and connect workloads, which vary according to the service provider. Using the xref:../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#understanding-service-binding-operator[Service Binding Operator], as a developer, you can bind workloads together with Operator-managed backing services, without any manual procedures to configure the binding connection. You can apply service binding also on xref:../applications/connecting_applications_to_services/getting-started-with-service-binding-ibm-power-ibm-z.adoc#getting-started-with-service-binding-ibm-power-ibm-z[{ibm-power-name}, {ibm-z-name}, and {ibm-linuxone-name} environments].
An application uses backing services to build and connect workloads, which vary according to the service provider. Using the xref:../applications/connecting_applications_to_services/understanding-service-binding-operator.adoc#understanding-service-binding-operator[Service Binding Operator], as a developer, you can bind workloads together with Operator-managed backing services, without any manual procedures to configure the binding connection.
ifndef::openshift-dedicated,openshift-rosa[]
You can apply service binding also on xref:../applications/connecting_applications_to_services/getting-started-with-service-binding-ibm-power-ibm-z.adoc#getting-started-with-service-binding-ibm-power-ibm-z[IBM Power Systems, IBM Z, and LinuxONE environments].
endif::openshift-dedicated,openshift-rosa[]
[id="deploying-application"]
=== Deploying an application
@@ -47,4 +55,4 @@ You can also use xref:../applications/working_with_helm_charts/understanding-hel
[id="redhat-marketplace"]
== Using the Red Hat Marketplace
The xref:../applications/red-hat-marketplace.adoc#red-hat-marketplace[Red Hat Marketplace] is an open cloud marketplace where you can discover and access certified software for container-based environments that run on public clouds and on-premises.
The xref:../applications/red-hat-marketplace.adoc#red-hat-marketplace[Red Hat Marketplace] is an open cloud marketplace where you can discover and access certified software for container-based environments that run on public clouds and on-premises.

View File

@@ -9,10 +9,17 @@ toc::[]
You can edit the configuration and the source code of the application you create using the *Topology* view.
== Prerequisites
// When the Authentication book is added to ROSA/OSD, check if this link is valid.
ifndef::openshift-rosa,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[]
* 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[]
* 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[]
* You have logged in to the web console and have switched to the *Developer* perspective.
endif::openshift-rosa,openshift-dedicated[]
include::modules/odc-editing-source-code-using-developer-perspective.adoc[leveloffset=+1]

View File

@@ -13,7 +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[]
* 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[]
* You have logged in to the web console and have switched to the *Developer* perspective.
endif::openshift-rosa,openshift-dedicated[]
include::modules/odc-monitoring-your-project-metrics.adoc[leveloffset=+1]

View File

@@ -11,10 +11,16 @@ 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[]
* 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 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].
* 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[]
* You have logged in to the web console.
* You are in the *Developer* perspective.
endif::openshift-rosa,openshift-dedicated[]
include::modules/odc-viewing-application-topology.adoc[leveloffset=+1]
@@ -37,4 +43,6 @@ include::modules/odc-labels-and-annotations-used-for-topology-view.adoc[leveloff
* 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.
* See xref:../applications/connecting_applications_to_services/odc-connecting-an-application-to-a-service-using-the-developer-perspective.adoc#odc-connecting-an-application-to-a-service-using-the-developer-perspective[Connecting an application to a service using the Developer perspective].
* See xref:../applications/odc-exporting-applications.adoc#odc-exporting-applications[Exporting applications]
ifndef::openshift-rosa,openshift-dedicated[]
* See xref:../applications/odc-exporting-applications.adoc#odc-exporting-applications[Exporting applications].
endif::openshift-rosa,openshift-dedicated[]

View File

@@ -11,10 +11,31 @@ isolation from other communities.
[NOTE]
====
Projects starting with `openshift-` and `kube-` are xref:../../authentication/using-rbac.adoc#rbac-default-projects_using-rbac[default projects]. 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. Cluster administrators can create these projects using the `oc adm new-project` command.
Projects starting with `openshift-` and `kube-` are
ifndef::openshift-dedicated,openshift-rosa[]
xref:../../authentication/using-rbac.adoc#rbac-default-projects_using-rbac[default projects].
endif::openshift-dedicated,openshift-rosa[]
ifdef::openshift-dedicated,openshift-rosa[]
default projects.
endif::openshift-dedicated,openshift-rosa[]
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.
endif::openshift-dedicated[]
ifdef::openshift-dedicated[]
For {product-title} clusters that use the Customer Cloud Subscription (CCS) model, users with `cluster-admin` privileges can create these projects using the `oc adm new-project` command.
endif::openshift-dedicated[]
====
ifndef::openshift-dedicated[]
include::snippets/default-projects.adoc[]
endif::openshift-dedicated[]
ifdef::openshift-dedicated[]
[NOTE]
====
In {product-title} clusters that use the Customer Cloud Subscription (CCS) model, you cannot assign an SCC to pods created in one of the default namespaces: `default`, `kube-system`, `kube-public`, `openshift-node`, `openshift-infra`, and `openshift`. You cannot use these namespaces for running pods or services. You cannot create any SCCs for {product-title} clusters that use a Red Hat cloud account, because SCC resource creation requires `cluster-admin` privileges.
====
endif::openshift-dedicated[]
include::modules/creating-a-project-using-the-web-console.adoc[leveloffset=+1]

View File

@@ -10,21 +10,33 @@ 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[]
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[]
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[]
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[]
[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[]
include::modules/pruning-images.adoc[leveloffset=+1]
//cannot create resource "serviceaccounts". cannot create resource "cronjobs"
ifndef::openshift-rosa,openshift-dedicated[]
include::modules/pruning-images-manual.adoc[leveloffset=+1]
[role="_additional-resources"]
@@ -35,12 +47,23 @@ 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[]
// cannot patch resource "configs"
ifndef::openshift-rosa,openshift-dedicated[]
include::modules/pruning-hard-pruning-registry.adoc[leveloffset=+1]
endif::openshift-rosa,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[]
* xref:../nodes/jobs/nodes-nodes-jobs.adoc#nodes-nodes-jobs_nodes-nodes-jobs[Running tasks in pods using jobs]
endif::openshift-rosa,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[]
* xref:../authentication/using-rbac.adoc#using-rbac[Using RBAC to define and apply permissions]
endif::openshift-rosa,openshift-dedicated[]

View File

@@ -7,10 +7,12 @@ include::_attributes/common-attributes.adoc[]
toc::[]
[role="_abstract"]
ifndef::openshift-rosa,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[]
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].
@@ -26,22 +28,40 @@ 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[]
include::modules/helm-installing-a-helm-chart-on-an-openshift-cluster.adoc[leveloffset=+1]
endif::openshift-rosa,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[]
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[]
You can use Helm by Accessing the web terminal in the *Developer* perspective of the web console.
endif::openshift-rosa,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[]
include::modules/helm-adding-helm-chart-repositories.adoc[leveloffset=+1]
endif::openshift-rosa,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[]
include::modules/helm-adding-namespace-scoped-helm-chart-repositories.adoc[leveloffset=+1]
endif::openshift-rosa,openshift-dedicated[]
//cannot create resource "helmchartrepositories" in API group "helm.openshift.io"
ifndef::openshift-rosa,openshift-dedicated[]
include::modules/helm-creating-credentials-and-certificates-to-add-helm-repositories.adoc[leveloffset=+1]
endif::openshift-rosa,openshift-dedicated[]
include::modules/helm-filtering-helm-charts-by-certification-level.adoc[leveloffset=+1]
ifndef::openshift-rosa,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[]

View File

@@ -15,6 +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[]
. Download the Helm binary and add it to your path:
* Linux (x86_64, amd64)
@@ -37,6 +38,15 @@ You can also find the URL to the latest binaries from the {product-title} web co
----
# 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[]
. 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[]
. Make the binary file executable:
+

View File

@@ -10,7 +10,12 @@ You can use the *Developer* perspective in the web console to update, rollback,
== Prerequisites
ifndef::openshift-rosa,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[]
* You have logged in to the web console and have switched to the *Developer* perspective.
endif::openshift-rosa,openshift-dedicated[]
include::modules/odc-upgrading-helm-release.adoc[leveloffset=+1]

View File

@@ -26,10 +26,13 @@ Helm provides the ability to:
* Create your own charts with {product-title} or Kubernetes resources.
* 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[]
//[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).
// 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[]
== Red Hat Certification of Helm charts for OpenShift

View File

@@ -10,7 +10,13 @@ If allowed by your cluster administrator, you can create a new project.
[NOTE]
====
Projects starting with `openshift-` and `kube-` are considered critical by {product-title}. As such, {product-title} does not allow you to create Projects starting with `openshift-` or `kube-` using the `oc new-project` command. Cluster administrators can create these Projects using the `oc adm new-project` command.
Projects starting with `openshift-` and `kube-` are considered critical by {product-title}. 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.
endif::openshift-dedicated[]
ifdef::openshift-dedicated[]
For {product-title} clusters that use the Customer Cloud Subscription (CCS) model, users with `cluster-admin` privileges can create these projects using the `oc adm new-project` command.
endif::openshift-dedicated[]
====
.Procedure
@@ -35,7 +41,7 @@ $ oc new-project hello-openshift \
[NOTE]
====
The number of projects you are allowed to create
ifdef::openshift-enterprise,openshift-webscale,openshift-origin[]
ifdef::openshift-enterprise,openshift-webscale,openshift-origin,openshift-dedicated,openshift-rosa[]
might be limited by the system administrator.
endif::[]
ifdef::openshift-online[]

View File

@@ -26,4 +26,4 @@ Options menu {kebab}.
. When the *Delete Project* pane opens, enter the name of the project that
you want to delete in the field.
. Click *Delete*.
. Click *Delete*.

View File

@@ -12,6 +12,14 @@ new projects are created using your custom requirements.
To create your own custom project template:
.Prerequisites
ifndef::openshift-rosa,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[]
* You have access to an {product-title} cluster using an account with `dedicated-admin` permissions.
endif::openshift-rosa,openshift-dedicated[]
.Procedure
. Log in as a user with `cluster-admin` privileges.

View File

@@ -5,7 +5,13 @@
You can use either the *Developer* perspective in the web console or the CLI to select and create a release from the Helm charts listed in the *Developer Catalog*. You can create Helm releases by installing Helm charts and see them in the *Developer* perspective of the web console.
.Prerequisites
ifndef::openshift-rosa,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[]
* You have logged in to the web console and have switched to the *Developer* perspective.
endif::openshift-rosa,openshift-dedicated[]
.Procedure
To create Helm releases from the Helm charts provided in the *Developer Catalog*:

View File

@@ -10,7 +10,13 @@ You can use the *Developer* perspective in the {product-title} web console to cr
[NOTE]
====
Projects starting with `openshift-` and `kube-` are considered critical by {product-title}. As such, {product-title} does not allow you to create projects starting with `openshift-` or `kube-` using the *Developer* perspective. Cluster administrators can create these projects using the `oc adm new-project` command.
Projects starting with `openshift-` and `kube-` are considered critical by {product-title}. As such, {product-title} does not allow you to create projects starting with `openshift-` or `kube-` using the *Developer* perspective.
ifndef::openshift-rosa,openshift-dedicated[]
Cluster administrators can create these projects using the `oc adm new-project` command.
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
For {product-title} clusters that use the Customer Cloud Subscription (CCS) model, users with `cluster-admin` privileges can create these projects using the `oc adm new-project` command.
endif::openshift-rosa,openshift-dedicated[]
====
.Prerequisites

View File

@@ -24,5 +24,7 @@ You can use an external image registry or an image stream tag from an internal r
. In the *Resource type* section, select the resource type to generate:
.. Select *Deployment* to enable declarative updates for `Pod` and `ReplicaSet` objects.
.. Select *DeploymentConfig* to define the template for a `Pod` object, and manage deploying new images and configuration sources.
ifndef::openshift-rosa,openshift-dedicated[]
.. Select *Serverless Deployment* to enable scaling to zero when idle.
endif::openshift-rosa,openshift-dedicated[]
. Click *Create*. You can view the build status of the application in the *Topology* view.

View File

@@ -16,7 +16,12 @@ You can use the web console *Developer* perspective to upload a JAR file by usin
.Prerequisites
ifndef::openshift-rosa,openshift-dedicated[]
* The Cluster Samples Operator must be installed by a cluster administrator.
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
* The Cluster Samples Operator must be installed by a user with the `dedicated-admin` role.
endif::openshift-rosa,openshift-dedicated[]
* You have access to the {product-title} web console and are in the *Developer* perspective.
.Procedure

View File

@@ -12,5 +12,7 @@ You can use the *Topology* view in the *Developer* perspective to edit the sourc
====
This feature is available only when you create applications using the *From Git*, *From Catalog*, and the *From Dockerfile* options.
====
ifndef::openshift-rosa,openshift-dedicated[]
+
If the *Eclipse Che* Operator is installed in your cluster, a Che workspace (image:odc_che_workspace.png[title="Che Workspace"]) is created and you are directed to the workspace to edit your source code. If it is not installed, you will be directed to the Git repository (image:odc_git_repository.png[title="Git Repository"]) your source code is hosted in.
endif::openshift-rosa,openshift-dedicated[]

View File

@@ -48,12 +48,14 @@ The resource name must be unique in a namespace. Modify the resource name if you
* *Deployment*, to create an application in plain Kubernetes style.
* *Deployment Config*, to create an {product-title} style application.
ifndef::openshift-rosa,openshift-dedicated[]
* *Serverless Deployment*, to create a Knative service.
+
[NOTE]
====
To set the default resource preference for importing an application, go to *User Preferences* -> *Applications* -> *Resource type* field. The *Serverless Deployment* option is displayed in the *Import from Git* form only if the {ServerlessOperatorName} is installed in your cluster. The *Resources* section is not available while creating a serverless function. For further details, refer to the {ServerlessProductName} documentation.
====
endif::openshift-rosa,openshift-dedicated[]
. In the *Pipelines* section, select *Add Pipeline*, and then click *Show Pipeline Visualization* to see the pipeline for the application. A default pipeline is selected, but you can choose the pipeline you want from the list of available pipelines for the application.
+
@@ -83,7 +85,9 @@ If your application does not expose its data on the default public port, 80, cle
. Optional: You can use the following advanced options to further customize your application:
include::snippets/routing-odc.adoc[]
ifndef::openshift-rosa,openshift-dedicated[]
include::snippets/serverless-domain-mapping-odc.adoc[]
endif::openshift-rosa,openshift-dedicated[]
Health Checks::
Click the *Health Checks* link to add Readiness, Liveness, and Startup probes to your application. All the probes have prepopulated default data; you can add the probes with the default data or customize it as required.

View File

@@ -12,13 +12,20 @@ You can set the default user preferences for your cluster.
. Log in to the {product-title} web console using your login credentials.
. Use the masthead to access the user preferences under the user profile.
. In the *General* section:
.. In the **Theme** field, you can set the theme that you want to work in. The console defaults to the selected theme each time you log in.
.. In the **Theme** field, you can set the theme that you want to work in. The console defaults to the selected theme each time you log in.
.. In the *Perspective* field, you can set the default perspective you want to be logged in to. You can select the *Administrator* or the *Developer* perspective as required. If a perspective is not selected, you are logged into the perspective you last visited.
.. In the *Project* field, select a project you want to work in. The console defaults to the project every time you log in.
.. In the *Topology* field, you can set the topology view to default to the graph or list view. If not selected, the console defaults to the last view you used.
.. In the *Create/Edit resource method* field, you can set a preference for creating or editing a resource. If both the form and YAML options are available, the console defaults to your selection.
. In the *Language* section, select *Default browser language* to use the default browser language settings. Otherwise, select the language that you want to use for the console.
. In the *Notifications* section, you can toggle display notifications created by users for specific projects on the *Overview* page or notification drawer.
. In the *Notifications* section, you can toggle display notifications created by users for specific projects on the *Overview* page or notification drawer.
ifndef::openshift-rosa,openshift-dedicated[]
. In the *Applications* section:
.. You can view the default *Resource type*. For example, if the {ServerlessOperatorName} is installed, the default resource type is *Serverless Deployment*. Otherwise, the default resource type is *Deployment*.
.. You can select another resource type to be the default resource type from the *Resource Type* field.
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
. In the *Applications* section:
.. You can view the default *Resource type*. The default resource type is *Deployment*.
.. You can select another resource type to be the default resource type from the *Resource Type* field.
endif::openshift-rosa,openshift-dedicated[]

View File

@@ -20,10 +20,15 @@ You can customize the views as required using the following:
*** Virtual Machines: Toggle to show or hide the virtual machines.
*** Application Groupings: Clear to condense the application groups into cards with an overview of an application group and alerts associated with it.
*** Helm Releases: Clear to condense the components deployed as Helm Release into cards with an overview of a given release.
ifndef::openshift-rosa,openshift-dedicated[]
*** Knative Services: Clear to condense the Knative Service components into cards with an overview of a given component.
endif::openshift-rosa,openshift-dedicated[]
*** Operator Groupings: Clear to condense the components deployed with an Operator into cards with an overview of the given group.
** *Show* elements based on *Pod Count* or *Labels*
*** Pod Count: Select to show the number of pods of a component in the component icon.
*** Labels: Toggle to show or hide the component labels.
// cannot create namespace required to export
ifndef::openshift-rosa,openshift-dedicated[]
The *Topology* view also provides you the *Export application* option to download your application in the ZIP file format. You can then import the downloaded application to another project or cluster. For more details, see _Exporting an application to another project or cluster_ in the _Additional resources_ section.
endif::openshift-rosa,openshift-dedicated[]

View File

@@ -41,6 +41,7 @@ To also prune replica sets associated with `Deployment` objects, use the `--repl
.^|`--orphans`
|Prune all replication controllers that no longer have a `DeploymentConfig` object, has status of `Complete` or `Failed`, and has a replica count of zero.
ifndef::openshift-rosa,openshift-dedicated[]
.^|`--replica-sets=true\|false`
|If `true`, replica sets are included in the pruning process. The default is `false`.
@@ -48,6 +49,7 @@ To also prune replica sets associated with `Deployment` objects, use the `--repl
====
This flag is a Technology Preview feature.
====
endif::openshift-rosa,openshift-dedicated[]
|===
.Procedure

View File

@@ -10,7 +10,12 @@ Images from the {product-registry} that are no longer required by the system due
.Prerequisites
* Cluster administrator permissions.
ifndef::openshift-rosa,openshift-dedicated[]
* You have access to an {product-title} cluster using an account with cluster administrator permissions.
endif::openshift-rosa,openshift-dedicated[]
ifdef::openshift-rosa,openshift-dedicated[]
* You have access to an {product-title} cluster using an account with `dedicated-admin` permissions.
endif::openshift-rosa,openshift-dedicated[]
* Install the `oc` CLI.
.Procedure