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

Applications docs fixes during ROSA review

This commit is contained in:
Michael Burke
2023-09-13 14:11:24 -04:00
committed by openshift-cherrypick-robot
parent 1fe5662609
commit 6062fec7b5
38 changed files with 311 additions and 165 deletions

View File

@@ -2130,9 +2130,9 @@ Topics:
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
- Name: Creating applications by using the CLI
File: creating-applications-using-cli
- Name: Viewing application composition using the Topology view
- Name: Viewing application composition by using the Topology view
File: odc-viewing-application-composition-using-topology-view
- Name: Exporting applications
File: odc-exporting-applications

View File

@@ -10,10 +10,12 @@ Config maps allow you to decouple configuration artifacts from image content to
The following sections define config maps and how to create and use them.
For information on creating config maps, see xref:../nodes/pods/nodes-pods-configmaps.adoc[Creating and using config maps].
include::modules/nodes-pods-configmap-overview.adoc[leveloffset=+1]
.Additional resources
* xref:../nodes/pods/nodes-pods-configmaps.adoc[Creating and using config maps]
[id="nodes-pods-config-maps-consuming-configmap-in-pods"]
== Use cases: Consuming config maps in pods

View File

@@ -26,4 +26,6 @@ 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].

View File

@@ -11,11 +11,11 @@ toc::[]
Use the *Topology* view for the following purposes:
** Group multiple components within an application.
* Grouping multiple components within an application.
** Connect components with each other.
* Connecting components with each other.
** Connect multiple resources to services with labels.
* Connecting multiple resources to services with labels.
You can either use a binding or a visual connector to connect components.
@@ -33,5 +33,5 @@ include::modules/odc-visualizing-the-binding-connections-to-resources.adoc[level
[role="_additional-resources"]
[id="additional-resources-odc-connecting-an-application-to-a-service-using-the-developer-perspective"]
== Additional resources
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding].
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators].
* xref:../../applications/connecting_applications_to_services/getting-started-with-service-binding.adoc#getting-started-with-service-binding[Getting started with service binding]
* link:https://github.com/redhat-developer/service-binding-operator#known-bindable-operators[Known bindable Operators]

View File

@@ -20,4 +20,4 @@ include::modules/sbo-api-differences.adoc[leveloffset=+1]
[role="_additional-resources"]
[id="additional-resources_understanding-sbo"]
== 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

@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="creating-applications-using-cli"]
= Creating applications using the CLI
= Creating applications by using the CLI
include::_attributes/common-attributes.adoc[]
:context: creating-applications-using-cli

View File

@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="odc-creating-applications-using-developer-perspective"]
= Creating applications using the Developer perspective
= Creating applications by using the Developer perspective
include::_attributes/common-attributes.adoc[]
:context: odc-creating-applications-using-developer-perspective

View File

@@ -13,7 +13,7 @@ Using {product-title}, you can create, edit, delete, and manage applications usi
Using projects, you can organize and manage applications in isolation. You can manage the entire project lifecycle, including xref:../applications/projects/working-with-projects.adoc#working-with-projects[creating, viewing, and deleting a project] in {product-title}.
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.
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[]
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].
@@ -28,14 +28,15 @@ endif::openshift-rosa,openshift-dedicated[]
[id="creating-application"]
=== Creating an application
To create applications, you must have created a project or have access to a project with the appropriate roles and permissions. You can create an application by using either xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[the Developer perspective in the web console], xref:../applications/creating_applications/creating-apps-from-installed-operators.adoc#creating-apps-from-installed-operators[installed Operators], or xref:../applications/creating_applications/creating-applications-using-cli.adoc#creating-applications-using-cli[the {product-title} CLI]. You can source the applications to be added to the project from Git, JAR files, devfiles, or the developer catalog.
To create applications, you must have created a project or have access to a project with the appropriate roles and permissions. You can create an application by using either xref:../applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc#odc-creating-applications-using-developer-perspective[the Developer perspective in the web console], xref:../applications/creating_applications/creating-apps-from-installed-operators.adoc#creating-apps-from-installed-operators[installed Operators], or xref:../applications/creating_applications/creating-applications-using-cli.adoc#creating-applications-using-cli[the {oc-first}]. You can source the applications to be added to the project from Git, JAR files, devfiles, or the developer catalog.
You can also use components that include source or binary code, images, and templates to create an application by using the {product-title} CLI. With the {product-title} web console, you can create an application from an Operator installed by a cluster administrator.
You can also use components that include source or binary code, images, and templates to create an application by using the {oc-first}. With the {product-title} web console, you can create an application from an Operator installed by a cluster administrator.
[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"]

View File

@@ -1,6 +1,6 @@
:_mod-docs-content-type: ASSEMBLY
[id="odc-viewing-application-composition-using-topology-view"]
= Viewing application composition using the Topology view
= Viewing application composition by using the Topology view
include::_attributes/common-attributes.adoc[]
:context: viewing-application-composition-using-topology-view

View File

@@ -37,26 +37,53 @@ In {product-title} clusters that use the Customer Cloud Subscription (CCS) model
====
endif::openshift-dedicated[]
include::modules/creating-a-project-using-the-web-console.adoc[leveloffset=+1]
[id="working-with-projects-create-project"]
== Creating a project
include::modules/odc-creating-projects-using-developer-perspective.adoc[leveloffset=+1]
You can use the {product-title} web console or the {oc-first} to create a project in your cluster.
include::modules/creating-a-project-using-the-CLI.adoc[leveloffset=+1]
include::modules/creating-a-project-using-the-web-console.adoc[leveloffset=+2]
include::modules/viewing-a-project-using-the-web-console.adoc[leveloffset=+1]
// include modules/odc-creating-projects-using-developer-perspective.adoc[leveloffset=+2]
include::modules/viewing-a-project-using-the-CLI.adoc[leveloffset=+1]
.Additional resources
* xref:../../applications/projects/working-with-projects.adoc#odc-customizing-available-cluster-roles-using-the-web-console_projects[Customizing the available cluster roles using the web console]
include::modules/creating-a-project-using-the-CLI.adoc[leveloffset=+2]
[id="working-with-projects-viewing-project"]
== Viewing a project
You can use the {product-title} web console or the {oc-first} to view a project in your cluster.
include::modules/viewing-a-project-using-the-web-console.adoc[leveloffset=+2]
include::modules/viewing-a-project-using-the-CLI.adoc[leveloffset=+2]
include::modules/odc-providing-project-permissions-using-developer-perspective.adoc[leveloffset=+1]
include::modules/odc-customizing-available-cluster-roles-using-developer-perspective.adoc[leveloffset=+1]
include::modules/odc-customizing-available-cluster-roles-using-the-web-console.adoc[leveloffset=+1]
include::modules/adding-to-a-project.adoc[leveloffset=+1]
include::modules/checking-project-status-using-the-web-console.adoc[leveloffset=+1]
[id="working-with-projects-viewing-project-status"]
== Checking the project status
include::modules/checking-project-status-using-the-CLI.adoc[leveloffset=+1]
You can use the {product-title} web console or the {oc-first} to view the status of your project.
include::modules/deleting-a-project-using-the-web-console.adoc[leveloffset=+1]
include::modules/checking-project-status-using-the-web-console.adoc[leveloffset=+2]
include::modules/deleting-a-project-using-the-CLI.adoc[leveloffset=+1]
include::modules/checking-project-status-using-the-CLI.adoc[leveloffset=+2]
// The following text comes from deleting-a-project-using-the-CLI.adoc
[id="working-with-projects-deleting-project"]
== Deleting a project
You can use the {product-title} web console or the {oc-first} to delete a project.
When you delete a project, the server updates the project status to *Terminating* from *Active*. Then, the server clears all content from a project that is in the *Terminating* state before finally removing the project. While a project is in *Terminating* status, you cannot add new content to the project. Projects can be deleted from the CLI or the web console.
include::modules/deleting-a-project-using-the-web-console.adoc[leveloffset=+2]
include::modules/deleting-a-project-using-the-CLI.adoc[leveloffset=+2]

Binary file not shown.

Before

Width:  |  Height:  |  Size: 44 KiB

After

Width:  |  Height:  |  Size: 66 KiB

View File

@@ -6,18 +6,21 @@
[id="adding-to-a-project_{context}"]
= Adding to a project
You can add items to your project by using the *+Add* page in the *Developer* perspective.
.Prerequisites
* You have created a project.
.Procedure
. Select *Developer* from the context selector at the top of the web console
navigation menu.
. In the *Developer* perspective, navigate to the *+Add* page.
. Click *+Add*
. Select your project from the *Project* menu.
. At the top of the page, select the name of the project that you want to add to.
. Click a method for adding to your project, and then follow the workflow.
. Click on an item on the *+Add* page and then follow the workflow.
[NOTE]
====
You can also add components to the topology using quick search.
You can also use the search feature in the *+Add* page to find additional items to add to your project. Click *+* under *Add* at the top of the page and type the name of a component in the search field.
====

View File

@@ -4,16 +4,28 @@
:_mod-docs-content-type: PROCEDURE
[id="checking-project-status-using-the-CLI_{context}"]
= Checking project status using the CLI
= Checking project status by using the CLI
You can review the status of your project by using the {oc-first}.
.Prerequisites
* You have installed the {oc-first}.
* You have created a project.
.Procedure
. Run:
. Switch to your project:
+
[source,terminal]
----
$ oc project <project_name> <1>
----
<1> Replace `<project_name>` with the name of your project.
. Obtain a high-level overview of the project:
+
[source,terminal]
----
$ oc status
----
+
This command provides a high-level overview of the current project, with its
components and their relationships.

View File

@@ -4,10 +4,22 @@
:_mod-docs-content-type: PROCEDURE
[id="checking-project-status-using-the-web-console_{context}"]
= Checking project status using the web console
= Checking project status by using the web console
You can review the status of your project by using the web console.
.Prerequisites
* You have created a project.
.Procedure
. Navigate to *Home* -> *Projects*.
** If you are using the *Administrator* perspective:
.. Navigate to *Home* -> *Projects*.
.. Select a project from the list.
.. Review the project status in the *Overview* page.
. Select a project to see its status.
** If you are using the *Developer* perspective:
.. Navigate to the *Project* page.
.. Select a project from the *Project* menu.
.. Review the project status in the *Overview* page.

View File

@@ -4,7 +4,7 @@
:_mod-docs-content-type: PROCEDURE
[id="creating-a-project-using-the-CLI_{context}"]
= Creating a project using the CLI
= Creating a project by using the CLI
If allowed by your cluster administrator, you can create a new project.

View File

@@ -4,21 +4,42 @@
:_mod-docs-content-type: PROCEDURE
[id="creating-a-project-using-the-web-console_{context}"]
= Creating a project using the web console
= Creating a project by using the web console
If allowed by your cluster administrator, you can create a new project.
You can use the {product-title} web console to create a project in your cluster.
[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-` using the web console.
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-` using the web console.
====
.Prerequisites
* Ensure that you have the appropriate roles and permissions to create projects, applications, and other workloads in {product-title}.
.Procedure
. Navigate to *Home* -> *Projects*.
** If you are using the *Administrator* perspective:
.. Navigate to *Home* -> *Projects*.
.. Click *Create Project*:
... In the *Create Project* dialog box, enter a unique name, such as `myproject`, in the *Name* field.
... Optional: Add the *Display name* and *Description* details for the project.
... Click *Create*.
+
The dashboard for your project is displayed.
. Click *Create Project*.
.. Optional: Select the *Details* tab to view the project details.
.. Optional: If you have adequate permissions for a project, you can use the *Project Access* tab to provide or revoke admin, edit, and view privileges for the project.
. Enter your project details.
** If you are using the *Developer* perspective:
.. Click the *Project* menu and select *Create Project*:
+
.Create project
image::odc_create_project.png[]
. Click *Create*.
... In the *Create Project* dialog box, enter a unique name, such as `myproject`, in the *Name* field.
... Optional: Add the *Display name* and *Description* details for the project.
... Click *Create*.
.. Optional: Use the left navigation panel to navigate to the *Project* view and see the dashboard for your project.
.. Optional: In the project dashboard, select the *Details* tab to view the project details.
.. Optional: If you have adequate permissions for a project, you can use the *Project Access* tab of the project dashboard to provide or revoke admin, edit, and view privileges for the project.

View File

@@ -53,9 +53,10 @@ set the value to your custom message:
apiVersion: config.openshift.io/v1
kind: Project
metadata:
...
# ...
spec:
projectRequestMessage: <message_string>
# ...
----
+
For example:
@@ -66,9 +67,10 @@ For example:
apiVersion: config.openshift.io/v1
kind: Project
metadata:
...
# ...
spec:
projectRequestMessage: To request a project, contact your system administrator at projectname@example.com.
# ...
----
. After you save your changes, attempt to create a new project as a developer or

View File

@@ -4,19 +4,24 @@
:_mod-docs-content-type: PROCEDURE
[id="deleting-a-project-using-the-CLI_{context}"]
= Deleting a project using the CLI
= Deleting a project by using the CLI
When you delete a project, the server updates the project status to
*Terminating* from *Active*. Then, the server clears all content from a project
that is in the *Terminating* state before finally removing the project. While a
project is in *Terminating* status, you cannot add new content to the project.
Projects can be deleted from the CLI or the web console.
// Moved intro paragraph to working-with-projects.adoc
You can delete a project by using the {oc-first}.
.Prerequisites
* You have installed the {oc-first}.
* You have created a project.
* You have the required permissions to delete the project.
.Procedure
. Run:
. Delete your project:
+
[source,terminal]
----
$ oc delete project <project_name>
$ oc delete project <project_name> <1>
----
<1> Replace `<project_name>` with the name of the project that you want to delete.

View File

@@ -4,26 +4,39 @@
:_mod-docs-content-type: PROCEDURE
[id="deleting-a-project-using-the-web-console_{context}"]
= Deleting a project using the web console
= Deleting a project by using the web console
You can delete a project by using the {product-title} web console.
You can delete a project by using the web console.
[NOTE]
====
If you do not have permissions to delete the project, the *Delete Project*
option is not available.
====
.Prerequisites
* You have created a project.
* You have the required permissions to delete the project.
.Procedure
. Navigate to *Home* -> *Projects*.
. Locate the project that you want to delete from the list of projects.
. On the far right side of the project listing, select *Delete Project* from the
Options menu {kebab}.
. When the *Delete Project* pane opens, enter the name of the project that
you want to delete in the field.
** If you are using the *Administrator* perspective:
.. Navigate to *Home* -> *Projects*.
.. Select a project from the list.
.. Click the *Actions* drop-down menu for the project and select *Delete Project*.
+
[NOTE]
====
The *Delete Project* option is not available if you do not have the required permissions to delete the project.
====
. In the *Delete Project?* pane, confirm the deletion by entering the name of your project.
. Click *Delete*.
** If you are using the *Developer* perspective:
.. Navigate to the *Project* page.
.. Select the project that you want to delete from the *Project* menu.
.. Click the *Actions* drop-down menu for the project and select *Delete Project*.
+
[NOTE]
====
If you do not have the required permissions to delete the project, the *Delete Project* option is not available.
====
. In the *Delete Project?* pane, confirm the deletion by entering the name of your project.
. Click *Delete*.

View File

@@ -74,7 +74,7 @@ kind: ClusterRoleBinding
metadata:
annotations:
rbac.authorization.kubernetes.io/autoupdate: "false"
...
# ...
----
** To update the role binding by using a single command:

View File

@@ -67,10 +67,11 @@ is `project-request`.
apiVersion: config.openshift.io/v1
kind: Project
metadata:
...
# ...
spec:
projectRequestTemplate:
name: <template_name>
# ...
----
. After you save your changes, create a new project to verify that your changes

View File

@@ -1,20 +1,23 @@
// Module included in the following assemblies:
//
// applications/application_life_cycle_management/odc-viewing-application-composition-using-topology-view.adoc
// applications/odc-viewing-application-composition-using-topology-view.adoc
:_mod-docs-content-type: PROCEDURE
[id="odc-adding-components-to-an-existing-project_{context}"]
= Adding components to an existing project
You can add components to a project.
.Procedure
. Navigate to the *+Add* view.
. Click *Add to Project* (image:odc_add_to_project.png[title="Add to Project"]) next to left navigation pane or press kbd:[Ctrl+Space]
. Search for the component and select *Create* or press kbd:[Enter] to add the component to the project and see it in the topology *Graph view*.
. Search for the component and click the *Start*/*Create*/*Install* button or click kbd:[Enter] to add the component to the project and see it in the topology *Graph view*.
+
.Adding component via quick search
image::odc_quick_search.png[]
Alternatively, you can also use the *Import from Git*, *Container Image*, *Database*, *From Catalog*, *Operator Backed*, *Helm Charts*, *Samples*, or *Upload JAR file* options in the context menu by right-clicking in the topology *Graph view* to add a component to your project.
Alternatively, you can also use the available options in the context menu, such as *Import from Git*, *Container Image*, *Database*, *From Catalog*, *Operator Backed*, *Helm Charts*, *Samples*, or *Upload JAR file*, by right-clicking in the topology *Graph view* to add a component to your project.
.Context menu to add services
image::odc_context_project.png[]

View File

@@ -16,6 +16,8 @@ This procedure walks you through an example of creating a visual connection betw
.Procedure
. In the *Developer* perspective, switch to the relevant project, for example, `my-petclinic`.
. Hover over the Spring PetClinic sample application to see a dangling arrow on the node.
+
.Visual connector
@@ -26,4 +28,4 @@ image::odc_connector.png[]
. Optional: You can repeat these steps to establish visual connections between other applications and components you create.
+
.Connecting multiple applications
image::odc_connecting_multiple_applications.png[]
image::odc_connecting_multiple_applications.png[]

View File

@@ -4,7 +4,7 @@
:_mod-docs-content-type: PROCEDURE
[id="odc-creating-projects-using-developer-perspective_{context}"]
= Creating a project using the Developer perspective in the web console
= Creating a project by using the Developer perspective in the web console
You can use the *Developer* perspective in the {product-title} web console to create a project in your cluster.
@@ -26,17 +26,14 @@ endif::openshift-rosa,openshift-dedicated[]
.Procedure
You can create a project using the *Developer* perspective, as follows:
. Click the *Project* drop-down menu to see a list of all available projects. Select *Create Project*.
. Click the *Project* menu and select *Create Project*:
+
.Create project
image::odc_create_project.png[]
. In the *Create Project* dialog box, enter a unique name, such as `myproject`, in the *Name* field.
. Optional: Add the *Display Name* and *Description* details for the project.
. Click *Create*.
. Use the left navigation panel to navigate to the *Project* view and see the dashboard for your project.
. Optional:
+
* Use the *Project* drop-down menu at the top of the screen and select *all projects* to list all of the projects in your cluster.
* Use the *Details* tab to see the project details.
* If you have adequate permissions for a project, you can use the *Project Access* tab to provide or revoke _administrator_, _edit_, and _view_ privileges for the project.
.. In the *Create Project* dialog box, enter a unique name, such as `myproject`, in the *Name* field.
.. Optional: Add the *Display name* and *Description* details for the project.
.. Click *Create*.
. Optional: Use the navigation panel to navigate to the *Project* view and see the dashboard for your project.
. Optional: In the project dashboard, select the *Details* tab to view the project details.
. Optional: If you have adequate permissions for a project, you can use the *Project Access* tab of the project dashboard to provide or revoke admin, edit, and view privileges for the project.

View File

@@ -1,6 +1,6 @@
:_mod-docs-content-type: PROCEDURE
[id="odc-creating-sample-applications_{context}"]
= Creating Sample applications
= Creating sample applications
You can use the sample applications in the *+Add* flow of the *Developer* perspective to create, build, and deploy applications quickly.
@@ -10,7 +10,7 @@ You can use the sample applications in the *+Add* flow of the *Developer* perspe
.Procedure
. In the *+Add* view, click on the *Samples* tile to see the *Samples* page.
. In the *+Add* view, click the *Samples* tile to see the *Samples* page.
. On the *Samples* page, select one of the available sample applications to see the *Create Sample Application* form.
. In the *Create Sample Application Form*:
* In the *Name* field, the deployment name is displayed by default. You can modify this name as required.

View File

@@ -1,33 +0,0 @@
// Module included in the following assemblies:
//
// applications/projects/working-with-projects.adoc
[id="odc-customizing-available-cluster-roles-using-developer-perspective_{context}"]
= Customizing the available cluster roles using the Developer perspective
The users of a project are assigned to a cluster role based on their access control. You can access these cluster roles by navigating to the *Project* -> *Project access* -> *Role*. By default, these roles are *Admin*, *Edit*, and *View*.
To add or edit the cluster roles for a project, you can customize the YAML code of the cluster.
.Procedure
To customize the different cluster roles of a project:
. In the *Search* view, use the *Resources* drop-down list to search for `Console`.
. From the available options, select the *Console `operator.openshift.io/v1`*.
+
.Searching Console resource
image::odc_cluster_console.png[]
. Select *cluster* under the *Name* list.
. Navigate to the *YAML* tab to view and edit the YAML code.
. In the YAML code under `spec`, add or edit the list of `availableClusterRoles` and save your changes:
+
[source,yaml]
----
spec:
customization:
projectAccess:
availableClusterRoles:
- admin
- edit
- view
----

View File

@@ -0,0 +1,47 @@
// Module included in the following assemblies:
//
// applications/projects/working-with-projects.adoc
[id="odc-customizing-available-cluster-roles-using-the-web-console_{context}"]
= Customizing the available cluster roles using the web console
In the *Developer* perspective of the web console, the *Project* -> *Project access* page enables a project administrator to grant roles to users in a project. By default, the available cluster roles that can be granted to users in a project are admin, edit, and view.
As a cluster administrator, you can define which cluster roles are available in the *Project access* page for all projects cluster-wide. You can specify the available roles by customizing the `spec.customization.projectAccess.availableClusterRoles` object in the `Console` configuration resource.
.Prerequisites
* You have access to the cluster as a user with the `cluster-admin` role.
.Procedure
. In the *Administrator* perspective, navigate to *Administration* -> *Cluster settings*.
. Click the *Configuration* tab.
. From the *Configuration resource* list, select *Console `operator.openshift.io`*.
. Navigate to the *YAML* tab to view and edit the YAML code.
. In the YAML code under `spec`, customize the list of available cluster roles for project access. The following example specifies the default `admin`, `edit`, and `view` roles:
+
[source,yaml]
----
apiVersion: operator.openshift.io/v1
kind: Console
metadata:
name: cluster
# ...
spec:
customization:
projectAccess:
availableClusterRoles:
- admin
- edit
- view
----
+
. Click *Save* to save the changes to the `Console` configuration resource.
.Verification
. In the *Developer* perspective, navigate to the *Project* page.
. Select a project from the *Project* menu.
. Select the *Project access* tab.
. Click the menu in the *Role* column and verify that the available roles match the configuration that you applied to the `Console` resource configuration.

View File

@@ -11,11 +11,11 @@ As a user, if you want to create a bindable service, you must know which service
* To discover and identify Operator-backed bindable services, consider the following alternative approaches:
+
** Click *+Add* -> *Developer Catalog* -> *Operator Backed* to see the Operator-backed tiles. Operator-backed services that support service binding features have a *Bindable* badge on the tiles.
** On the left pane of the *Operator Backed* page, select the *Bindable* checkbox.
** On the left pane of the *Operator Backed* page, select *Bindable*.
+
[TIP]
====
Click the help icon next to *Service binding* to see more information about bindable services.
====
** Click *+Add* -> *Add* and search for Operator-backed services. When you click the bindable service, you can view the *Bindable* badge in the side panel to the right.
** Click *+Add* -> *Add* and search for Operator-backed services. When you click the bindable service, you can view the *Bindable* badge in the side panel.

View File

@@ -1,7 +1,11 @@
// Module included in the following assemblies:
//
// * /applications/odc-viewing-application-composition-using-topology-view.adoc
[id="odc-interacting-with-applications-and-components_{context}"]
= Interacting with applications and components
The *Topology* view in the *Developer* perspective of the web console provides the following options to interact with applications and components:
In the *Topology* view in the *Developer* perspective of the web console, the *Graph view* provides the following options to interact with applications and components:
* Click *Open URL* (image:odc_open_url.png[title="Application Link"]) to see your application exposed by the route on a public URL.
* Click *Edit Source code* to access your source code and modify it.

View File

@@ -8,12 +8,17 @@
You can use the *Project* view in the *Developer* perspective to grant or revoke access permissions to your project.
.Prerequisites
* You have created a project.
.Procedure
To add users to your project and provide *Admin*, *Edit*, or *View* access to them:
. In the *Developer* perspective, navigate to the *Project* view.
. In the *Project* page, select the *Project Access* tab.
. Click *Add Access* to add a new row of permissions to the default ones.
. In the *Developer* perspective, navigate to the *Project* page.
. Select your project from the *Project* menu.
. Select the *Project Access* tab.
. Click *Add access* to add a new row of permissions to the default ones.
+
.Project permissions
image::odc_project_permissions.png[]

View File

@@ -1,10 +1,14 @@
// Module included in the following assemblies:
//
// * //applications/odc-viewing-application-composition-using-topology-view.adoc
[id="odc-scaling-application-pods-and-checking-builds-and-routes_{context}"]
= Scaling application pods and checking builds and routes
The *Topology* view provides the details of the deployed components in the *Overview* panel. You can use the *Overview* and *Resources* tabs to scale the application pods, check build status, services, and routes as follows:
The *Topology* view provides the details of the deployed components in the *Overview* panel. You can use the *Overview* and *Details* tabs to scale the application pods, check build status, services, and routes as follows:
* Click on the component node to see the *Overview* panel to the right. Use the *Overview* tab to:
* Click on the component node to see the *Overview* panel to the right. Use the *Details* tab to:
** Scale your pods using the up and down arrows to increase or decrease the number of instances of the application manually. For serverless applications, the pods are automatically scaled down to zero when idle and scaled up depending on the channel traffic.
** Check the *Labels*, *Annotations*, and *Status* of the application.

View File

@@ -4,7 +4,7 @@
:_mod-docs-content-type: PROCEDURE
[id="odc-using-quickstarts_{context}"]
= Creating applications using Quick Starts
= Creating applications by using Quick Starts
The *Quick Starts* page shows you how to create, import, and run applications on {product-title}, with step-by-step instructions and tasks.
@@ -14,6 +14,7 @@ The *Quick Starts* page shows you how to create, import, and run applications on
.Procedure
. In the *+Add* view, click the *View all quick starts* link to view the *Quick Starts* page.
. In the *+Add* view, click the *Getting Started resources* -> *Build with guided documentation* -> *View all quick starts* link to view the *Quick Starts* page.
. In the *Quick Starts* page, click the tile for the quick start that you want to use.
. Click *Start* to begin the quick start.
. Click *Start* to begin the quick start.
. Perform the steps that are displayed.

View File

@@ -1,3 +1,7 @@
// Module included in the following assemblies:
//
// applications/creating_applications/odc-creating-applications-using-developer-perspective.adoc
:_mod-docs-content-type: PROCEDURE
[id="odc-using-the-devfile-registry_{context}"]
= Using the Devfile registry to access devfiles
@@ -8,7 +12,7 @@ You can use the devfiles in the *+Add* flow of the *Developer* perspective to cr
. Navigate to *Developer Perspective* -> *+Add* -> *Developer Catalog* -> *All Services*. A list of all the available services in the *Developer Catalog* is displayed.
. Under *All Services*, select *Devfiles* to browse for devfiles that support a particular language or framework. Alternatively, you can use the keyword filter to search for a particular devfile using their name, tag, or description.
. Under *Type*, click *Devfiles* to browse for devfiles that support a particular language or framework. Alternatively, you can use the keyword filter to search for a particular devfile using their name, tag, or description.
. Click the devfile you want to use to create an application. The devfile tile displays the details of the devfile, including the name, description, provider, and the documentation of the devfile.

View File

@@ -19,25 +19,25 @@ You can specify the rules to change the binding names in the `.spec.namingStrate
.Example: Spring PetClinic sample application in the `ServiceBinding` CR
[source,yaml]
----
...
# ...
application:
name: spring-petclinic
group: apps
version: v1
resource: deployments
...
# ...
----
.Example: PostgreSQL database service in the `ServiceBinding` CR
[source,yaml]
----
...
# ...
services:
- group: postgres-operator.crunchydata.com
version: v1beta1
kind: PostgresCluster
name: hippo
...
# ...
----
If `namingStrategy` is not defined and the binding names are projected as environment variables, then the `host: hippo-pgbouncer` value in the backing service and the projected environment variable would appear as shown in the following example:
@@ -183,4 +183,4 @@ If you define the following pairs of fields, {servicebinding-title} refuses the
====
.Understanding the rebinding behavior
Consider a case where, after a successful binding, you use the `name` field to identify a workload. If you delete and recreate that workload, the `ServiceBinding` reconciler does not rebind the workload, and the Operator cannot project the binding data to the workload. However, if you use the `labelSelector` field to identify a workload, the `ServiceBinding` reconciler rebinds the workload, and the Operator projects the binding data.
Consider a case where, after a successful binding, you use the `name` field to identify a workload. If you delete and recreate that workload, the `ServiceBinding` reconciler does not rebind the workload, and the Operator cannot project the binding data to the workload. However, if you use the `labelSelector` field to identify a workload, the `ServiceBinding` reconciler rebinds the workload, and the Operator projects the binding data.

View File

@@ -25,7 +25,7 @@ metadata:
namespace: my-petclinic
annotations:
service.binding/username: path={.metadata.name}
...
# ...
----
[id="exposing-a-constant-value-as-the-binding-item_{context}"]
@@ -188,7 +188,7 @@ metadata:
annotations:
"service.binding/uri": "path={.status.connections},elementType=sliceOfMaps,sourceKey=type,sourceValue=url"
spec:
...
# ...
status:
connections:
- type: primary
@@ -341,4 +341,4 @@ The following example shows how to expose the values of collection entries with
- service.binding:endpoints:elementType=sliceOfStrings:sourceValue=url
----
////
// When the OLM descriptors are supported again, add this example.
// When the OLM descriptors are supported again, add this example.

View File

@@ -42,7 +42,7 @@ apiVersion: example.com/v1alpha1
kind: AccountService
name: prod-account-service
spec:
...
# ...
status:
binding:
name: hippo-pguser-hippo
@@ -58,7 +58,7 @@ metadata:
data:
password: "<password>"
user: "<username>"
...
# ...
----
When creating a service binding resource, you can directly give the details of the `AccountService` resource in the `ServiceBinding` specification as follows:
@@ -71,7 +71,7 @@ kind: ServiceBinding
metadata:
name: account-service
spec:
...
# ...
services:
- group: "example.com"
version: v1alpha1
@@ -92,7 +92,7 @@ kind: ServiceBinding
metadata:
name: account-service
spec:
...
# ...
service:
apiVersion: example.com/v1alpha1
kind: AccountService
@@ -117,7 +117,7 @@ kind: ServiceBinding
metadata:
name: account-service
spec:
...
# ...
services:
- group: ""
version: v1
@@ -133,7 +133,7 @@ kind: ServiceBinding
metadata:
name: account-service
spec:
...
# ...
service:
apiVersion: v1
kind: Secret
@@ -156,7 +156,7 @@ metadata:
namespace: my-petclinic
annotations:
service.binding: 'path={.metadata.name}-pguser-{.metadata.name},objectType=Secret'
...
# ...
----
The previous example places the name of the secret name in the `{.metadata.name}-pguser-{.metadata.name}` template that resolves to `hippo-pguser-hippo`. The template can contain multiple JSONPath expressions.
@@ -183,7 +183,7 @@ metadata:
namespace: my-petclinic
annotations:
service.binding: 'path={.metadata.name}-config,objectType=ConfigMap'
...
# ...
----
The previous example places the name of the config map in the `{.metadata.name}-config` template that resolves to `hippo-config`. The template can contain multiple JSONPath expressions.
@@ -270,4 +270,4 @@ spec:
In the previous example, `PostgresCluster` custom service resource owns one or more Kubernetes resources such as route, service, config map, or secret.
The {servicebinding-title} automatically detects the binding data exposed on each of the owned resources.
The {servicebinding-title} automatically detects the binding data exposed on each of the owned resources.

View File

@@ -24,11 +24,11 @@ metadata:
namespace: my-petclinic
annotations:
service.binding/username: path={.spec.name},optional=true
...
# ...
----
[NOTE]
====
* If you set the `optional` flag value to `false` and the {servicebinding-title} is unable to find the target path, the Operator fails the annotations mapping.
* If the `optional` flag has no value set, the {servicebinding-title} considers the value as `false` by default and fails the annotations mapping.
====
====

View File

@@ -4,12 +4,23 @@
:_mod-docs-content-type: PROCEDURE
[id="viewing-a-project-using-the-web-console_{context}"]
= Viewing a project using the web console
= Viewing a project by using the web console
You can view the projects that you have access to by using the {product-title} web console.
.Procedure
. Navigate to *Home* -> *Projects*.
** If you are using the *Administrator* perspective:
.. Navigate to *Home* -> *Projects* in the navigation menu.
.. Select a project to view. The *Overview* tab includes a dashboard for your project.
.. Select the *Details* tab to view the project details.
.. Select the *YAML* tab to view and update the YAML configuration for the project resource.
.. Select the *Workloads* tab to see workloads in the project.
.. Select the *RoleBindings* tab to view and create role bindings for your project.
. Select a project to view.
+
On this page, click *Workloads* to see workloads in the project.
** If you are using the *Developer* perspective:
.. Navigate to the *Project* page in the navigation menu.
.. Select *All Projects* from the *Project* drop-down menu at the top of the screen to list all of the projects in your cluster.
.. Select a project to view. The *Overview* tab includes a dashboard for your project.
.. Select the *Details* tab to view the project details.
.. If you have adequate permissions for a project, select the **Project access** tab view and update the privileges for the project.