Skip to content

Commit e7baec5

Browse files
mburke5678mburke5678
authored
Merge pull request #64658 from mburke5678/rosa-applications
[OSDOCS-3722] OCP content port to ROSA and OSD: Applications
2 parents 7bf1f9d + b5aa788 commit e7baec5

32 files changed

+412
-25
lines changed

‎_topic_maps/_topic_map_osd.yml

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -781,16 +781,107 @@ Topics:
781781
- Name: Secured routes
782782
File: secured-routes
783783
---
784-
Name: Applications
784+
Name: Building applications
785785
Dir: applications
786786
Distros: openshift-dedicated
787787
Topics:
788+
- Name: Building applications overview
789+
File: index
790+
- Name: Projects
791+
Dir: projects
792+
Topics:
793+
- Name: Working with projects
794+
File: working-with-projects
795+
# cannot impersonate resource "users" in API group
796+
# - Name: Creating a project as another user
797+
# File: creating-project-other-user
798+
- Name: Configuring project creation
799+
File: configuring-project-creation
800+
- Name: Creating applications
801+
Dir: creating_applications
802+
Topics:
803+
- Name: Creating applications using the Developer perspective
804+
File: odc-creating-applications-using-developer-perspective
805+
- Name: Creating applications from installed Operators
806+
File: creating-apps-from-installed-operators
807+
- Name: Creating applications using the CLI
808+
File: creating-applications-using-cli
809+
- Name: Viewing application composition using the Topology view
810+
File: odc-viewing-application-composition-using-topology-view
811+
# cannot create required namespace
812+
# - Name: Exporting applications
813+
# File: odc-exporting-applications
814+
- Name: Connecting applications to services
815+
Dir: connecting_applications_to_services
816+
Topics:
817+
- Name: Service Binding Operator release notes
818+
File: sbo-release-notes
819+
- Name: Understanding Service Binding Operator
820+
File: understanding-service-binding-operator
821+
- Name: Installing Service Binding Operator
822+
File: installing-sbo
823+
- Name: Getting started with service binding
824+
File: getting-started-with-service-binding
825+
# Not applicable to ROSA/OSD
826+
# - Name: Getting started with service binding on IBM Power, IBM Z, and IBM LinuxONE
827+
# File: getting-started-with-service-binding-ibm-power-ibm-z
828+
- Name: Exposing binding data from a service
829+
File: exposing-binding-data-from-a-service
830+
- Name: Projecting binding data
831+
File: projecting-binding-data
832+
- Name: Binding workloads using Service Binding Operator
833+
File: binding-workloads-using-sbo
834+
- Name: Connecting an application to a service using the Developer perspective
835+
File: odc-connecting-an-application-to-a-service-using-the-developer-perspective
836+
- Name: Working with Helm charts
837+
Dir: working_with_helm_charts
838+
Topics:
839+
- Name: Understanding Helm
840+
File: understanding-helm
841+
- Name: Installing Helm
842+
File: installing-helm
843+
- Name: Configuring custom Helm chart repositories
844+
File: configuring-custom-helm-chart-repositories
845+
- Name: Working with Helm releases
846+
File: odc-working-with-helm-releases
788847
- Name: Deployments
789848
Dir: deployments
790-
Distros: openshift-dedicated
791849
Topics:
792850
- Name: Custom domains for applications
793851
File: osd-config-custom-domains-applications
852+
- Name: Understanding Deployments and DeploymentConfigs
853+
File: what-deployments-are
854+
- Name: Managing deployment processes
855+
File: managing-deployment-processes
856+
- Name: Using deployment strategies
857+
File: deployment-strategies
858+
- Name: Using route-based deployment strategies
859+
File: route-based-deployment-strategies
860+
- Name: Quotas
861+
Dir: quotas
862+
Topics:
863+
- Name: Resource quotas per project
864+
File: quotas-setting-per-project
865+
- Name: Resource quotas across multiple projects
866+
File: quotas-setting-across-multiple-projects
867+
- Name: Using config maps with applications
868+
File: config-maps
869+
- Name: Monitoring project and application metrics using the Developer perspective
870+
File: odc-monitoring-project-and-application-metrics-using-developer-perspective
871+
- Name: Monitoring application health
872+
File: application-health
873+
- Name: Editing applications
874+
File: odc-editing-applications
875+
- Name: Working with quotas
876+
File: working-with-quotas
877+
- Name: Pruning objects to reclaim resources
878+
File: pruning-objects
879+
- Name: Idling applications
880+
File: idling-applications
881+
- Name: Deleting applications
882+
File: odc-deleting-applications
883+
- Name: Using the Red Hat Marketplace
884+
File: red-hat-marketplace
794885
---
795886
Name: Nodes
796887
Dir: nodes

‎_topic_maps/_topic_map_rosa.yml

Lines changed: 93 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,16 +1008,107 @@ Topics:
10081008
- Name: Secured routes
10091009
File: secured-routes
10101010
---
1011-
Name: Application development
1011+
Name: Building applications
10121012
Dir: applications
10131013
Distros: openshift-rosa
10141014
Topics:
1015+
- Name: Building applications overview
1016+
File: index
1017+
- Name: Projects
1018+
Dir: projects
1019+
Topics:
1020+
- Name: Working with projects
1021+
File: working-with-projects
1022+
# cannot impersonate resource "users" in API group
1023+
# - Name: Creating a project as another user
1024+
# File: creating-project-other-user
1025+
- Name: Configuring project creation
1026+
File: configuring-project-creation
1027+
- Name: Creating applications
1028+
Dir: creating_applications
1029+
Topics:
1030+
- Name: Creating applications using the Developer perspective
1031+
File: odc-creating-applications-using-developer-perspective
1032+
- Name: Creating applications from installed Operators
1033+
File: creating-apps-from-installed-operators
1034+
- Name: Creating applications using the CLI
1035+
File: creating-applications-using-cli
1036+
- Name: Viewing application composition using the Topology view
1037+
File: odc-viewing-application-composition-using-topology-view
1038+
# cannot create required namespace
1039+
# - Name: Exporting applications
1040+
# File: odc-exporting-applications
1041+
- Name: Connecting applications to services
1042+
Dir: connecting_applications_to_services
1043+
Topics:
1044+
- Name: Service Binding Operator release notes
1045+
File: sbo-release-notes
1046+
- Name: Understanding Service Binding Operator
1047+
File: understanding-service-binding-operator
1048+
- Name: Installing Service Binding Operator
1049+
File: installing-sbo
1050+
- Name: Getting started with service binding
1051+
File: getting-started-with-service-binding
1052+
# Not applicable to ROSA/OSD
1053+
# - Name: Getting started with service binding on IBM Power, IBM Z, and IBM LinuxONE
1054+
# File: getting-started-with-service-binding-ibm-power-ibm-z
1055+
- Name: Exposing binding data from a service
1056+
File: exposing-binding-data-from-a-service
1057+
- Name: Projecting binding data
1058+
File: projecting-binding-data
1059+
- Name: Binding workloads using Service Binding Operator
1060+
File: binding-workloads-using-sbo
1061+
- Name: Connecting an application to a service using the Developer perspective
1062+
File: odc-connecting-an-application-to-a-service-using-the-developer-perspective
1063+
- Name: Working with Helm charts
1064+
Dir: working_with_helm_charts
1065+
Topics:
1066+
- Name: Understanding Helm
1067+
File: understanding-helm
1068+
- Name: Installing Helm
1069+
File: installing-helm
1070+
- Name: Configuring custom Helm chart repositories
1071+
File: configuring-custom-helm-chart-repositories
1072+
- Name: Working with Helm releases
1073+
File: odc-working-with-helm-releases
10151074
- Name: Deployments
10161075
Dir: deployments
1017-
Distros: openshift-rosa
10181076
Topics:
10191077
- Name: Custom domains for applications
10201078
File: rosa-config-custom-domains-applications
1079+
- Name: Understanding Deployments and DeploymentConfigs
1080+
File: what-deployments-are
1081+
- Name: Managing deployment processes
1082+
File: managing-deployment-processes
1083+
- Name: Using deployment strategies
1084+
File: deployment-strategies
1085+
- Name: Using route-based deployment strategies
1086+
File: route-based-deployment-strategies
1087+
- Name: Quotas
1088+
Dir: quotas
1089+
Topics:
1090+
- Name: Resource quotas per project
1091+
File: quotas-setting-per-project
1092+
- Name: Resource quotas across multiple projects
1093+
File: quotas-setting-across-multiple-projects
1094+
- Name: Using config maps with applications
1095+
File: config-maps
1096+
- Name: Monitoring project and application metrics using the Developer perspective
1097+
File: odc-monitoring-project-and-application-metrics-using-developer-perspective
1098+
- Name: Monitoring application health
1099+
File: application-health
1100+
- Name: Editing applications
1101+
File: odc-editing-applications
1102+
- Name: Working with quotas
1103+
File: working-with-quotas
1104+
- Name: Pruning objects to reclaim resources
1105+
File: pruning-objects
1106+
- Name: Idling applications
1107+
File: idling-applications
1108+
- Name: Deleting applications
1109+
File: odc-deleting-applications
1110+
- Name: Using the Red Hat Marketplace
1111+
File: red-hat-marketplace
10211112
# - Name: Application GitOps workflows
10221113
# File: rosa-app-gitops-workflows
10231114
# - Name: Application logging

‎applications/application-health.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,5 +29,7 @@ include::modules/odc-monitoring-health-checks.adoc[leveloffset=+1]
2929

3030
[role="_additional-resources"]
3131
.Additional resources
32+
ifndef::openshift-rosa,openshift-dedicated[]
3233
* 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].
34+
endif::openshift-rosa,openshift-dedicated[]
3335
* 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.

‎applications/connecting_applications_to_services/exposing-binding-data-from-a-service.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,7 @@ include::modules/sbo-categories-of-exposable-binding-data.adoc[leveloffset=+1]
2323
== Additional resources
2424
// * link:https://github.com/openshift/console/blob/master/frontend/packages/operator-lifecycle-manager/src/components/descriptors/reference/reference.md[OLM Descriptor Reference].
2525
// When OLM descriptors are supported again, add this additional resource.
26+
ifndef::openshift-rosa,openshift-dedicated[]
2627
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#osdk-generating-csvs[Defining cluster service versions (CSVs)].
27-
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].
28+
endif::openshift-rosa,openshift-dedicated[]
29+
* xref:../../applications/connecting_applications_to_services/projecting-binding-data.adoc#projecting-binding-data[Projecting binding data].

‎applications/connecting_applications_to_services/getting-started-with-service-binding.adoc

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,30 @@ The {servicebinding-title} manages the data plane for workloads and backing serv
1414
[discrete]
1515
== Prerequisites
1616

17+
ifndef::openshift-rosa,openshift-dedicated[]
1718
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
19+
endif::openshift-rosa,openshift-dedicated[]
20+
ifdef::openshift-rosa,openshift-dedicated[]
21+
* You have access to an {product-title} cluster using an account with `dedicated-admin` permissions.
22+
endif::openshift-rosa,openshift-dedicated[]
1823
* You have installed the `oc` CLI.
1924
* You have installed {servicebinding-title} from OperatorHub.
25+
ifndef::openshift-rosa,openshift-dedicated[]
2026
* 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.
2127
+
2228
[NOTE]
2329
====
2430
You can create the namespace using the `oc create namespace my-petclinic` command.
2531
====
32+
endif::openshift-rosa,openshift-dedicated[]
33+
ifndef::openshift-rosa,openshift-dedicated[]
34+
* 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.
35+
+
36+
[NOTE]
37+
====
38+
You can create the project using the `oc new-project my-petclinic` command.
39+
====
40+
endif::openshift-rosa,openshift-dedicated[]
2641

2742
//Creating a PostgreSQL database instance
2843
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
3954
* xref:../../applications/connecting_applications_to_services/installing-sbo.adoc#installing-sbo[Installing Service Binding Operator].
4055
* xref:../../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[Creating applications using the Developer perspective].
4156
* xref:../../operators/understanding/crds/crd-managing-resources-from-crds.adoc[Managing resources from custom resource definitions].
42-
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
57+
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].

‎applications/connecting_applications_to_services/installing-sbo.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,14 @@ You can install {servicebinding-title} on {product-title} 4.7 and later.
1616
== Prerequisites
1717

1818
* You have access to an {product-title} cluster using an account with `cluster-admin` permissions.
19+
ifndef::openshift-rosa,openshift-dedicated[]
1920
* 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.
20-
21+
endif::openshift-rosa,openshift-dedicated[]
2122

2223
//Installing Service Binding Operator using web console
2324

2425
include::modules/op-installing-sbo-operator-using-the-web-console.adoc[leveloffset=+1]
2526

2627

2728
== Additional Resources
28-
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
29+
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].

‎applications/creating_applications/creating-apps-from-installed-operators.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,14 @@ have been installed by a cluster administrator.
1313
This guide walks developers through an example of creating applications from an
1414
installed Operator using the {product-title} web console.
1515

16+
ifndef::openshift-rosa,openshift-dedicated[]
1617
[role="_additional-resources"]
1718
.Additional resources
1819
1920
* See the
2021
xref:../../operators/understanding/olm-what-operators-are.adoc#olm-what-operators-are[Operators]
2122
guide for more on how Operators work and how the Operator Lifecycle Manager is
2223
integrated in {product-title}.
24+
endif::openshift-rosa,openshift-dedicated[]
2325
2426
include::modules/olm-creating-etcd-cluster-from-operator.adoc[leveloffset=+1]

‎applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,27 @@ The Managed services option is also available if the RHOAS Operator is installed
5252
ifdef::openshift-enterprise,openshift-webscale[]
5353
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.
5454
endif::[]
55+
// dedicated-admin cannot install the Serverless or Virtualization operators, cannot create namespace.
56+
// xref: ../../cicd/pipelines/installing-pipelines.adoc#op-installing-pipelines-operator-in-web-console_installing-pipelines[OpenShift Pipelines Operator]
57+
ifdef::openshift-rosa,openshift-dedicated[]
58+
Note that the *Pipelines* option is displayed only when the OpenShift Pipelines Operator is installed.
59+
endif::openshift-rosa,openshift-dedicated[]
5560

5661
[id="prerequisites_odc-creating-applications-using-developer-perspective"]
5762
== Prerequisites
5863

5964
To create applications using the *Developer* perspective ensure that:
6065

66+
ifndef::openshift-rosa,openshift-dedicated[]
6167
* You have xref:../../web_console/web-console.adoc#web-console[logged in to the web console].
6268
* 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}.
69+
endif::openshift-rosa,openshift-dedicated[]
70+
ifdef::openshift-rosa,openshift-dedicated[]
71+
* You have logged in to the web console.
72+
// * 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}.
73+
endif::openshift-rosa,openshift-dedicated[]
6374

75+
// dedicated-admin cannot install the Serverless operator. This ifdef should cover this.
6476
ifdef::openshift-enterprise,openshift-webscale[]
6577

6678
To create serverless applications, in addition to the preceding prerequisites, ensure that:

‎applications/deployments/managing-deployment-processes.adoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,10 +23,13 @@ include::modules/deployments-triggers.adoc[leveloffset=+2]
2323
include::modules/deployments-setting-triggers.adoc[leveloffset=+3]
2424
include::modules/deployments-setting-resources.adoc[leveloffset=+2]
2525

26+
// When the Nodes book is added to ROSA/OSD, check if this link is valid.
27+
ifndef::openshift-rosa,openshift-dedicated[]
2628
[role="_additional-resources"]
2729
.Additional resources
2830

2931
* 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].
32+
endif::openshift-rosa,openshift-dedicated[]
3033

3134
include::modules/deployments-scaling-manually.adoc[leveloffset=+2]
3235
include::modules/deployments-accessing-private-repos.adoc[leveloffset=+2]

0 commit comments

Comments
 (0)