Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add how to configure annotations #2023

Merged
merged 8 commits into from
Jun 11, 2021
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions modules/installation-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@
** xref:configuring-workspace-exposure-strategies.adoc[]
** xref:configuring-workspaces-nodeselector.adoc[]
** xref:configuring-che-hostname.adoc[]
** xref:configuring-labels-for-ingresses.adoc[]
** xref:configuring-labels-and-domains-for-routes.adoc[]
** xref:configuring-ingresses.adoc[]
** xref:configuring-routes.adoc[]
** xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]
** xref:installing-che-using-storage-classes.adoc[]
** xref:importing-untrusted-tls-certificates.adoc[]
Expand Down
6 changes: 6 additions & 0 deletions modules/installation-guide/pages/configuring-ingresses.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
[id="configuring-ingresses"]
:navtitle: Configuring {orch-ingress}
:keywords: installation-guide, configuring-ingresses
:page-aliases: .:configuring-ingresses

include::partial$proc_configuring-ingresses.adoc[]

This file was deleted.

This file was deleted.

7 changes: 7 additions & 0 deletions modules/installation-guide/pages/configuring-routes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[id="configuring-routes"]
// = Configuring Labels
:navtitle: Configuring OpenShift Route
:keywords: installation-guide, configuring-routes
:page-aliases: .:configuring-routes

include::partial$proc_configuring-routes.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,15 @@ The next sections describe some specific user stories.

* xref:configuring-namespace-strategies.adoc[]

* xref:configuring-the-number-of-workspaces-a-user-can-run.adoc[]
* xref:configuring-the-number-of-workspaces-a-user-can-run.adoc[]

* xref:configuring-workspaces-nodeselector.adoc[]

* xref:configuring-che-hostname.adoc[]

* xref:configuring-labels-for-ingresses.adoc[]
* xref:configuring-ingresses.adoc[]

* xref:configuring-labels-and-domains-for-routes.adoc[]
* xref:configuring-routes.adoc[]

* xref:deploying-che-with-support-for-git-repositories-with-self-signed-certificates.adoc[]

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@

[id="configuring-ingresses_{context}"]
= Configuring {orch-ingress}

* This procedure describes how to configure labels and annotations for {orch-ingress} to organize and categorize objects by scoping and selecting.

.Prerequisites

* The `{orch-cli}` tool is available.
* An instance of {prod-short} running in {orch-name}.

.Procedure

. To configure labels for {orch-ingress}, update the Custom Resource:
+
IMPORTANT: Use comma to separate labels: `key1=value1,key2=value2`
+
[subs="+quotes,+attributes"]
----
$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/cheServerIngress/labels", '\
'"value": "__<labels for a {prod-id-short} server ingress>__"}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/auth/identityProviderIngress/labels", '\
'"value": "__<labels for a {identity-provider} ingress>__"}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/pluginRegistryIngress/labels", '\
'"value": "__<labels for a plug-ins registry ingress>__"}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/devfileRegistryIngress/labels",'\
'"value": "__<labels for a devfile registry ingress>__"}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/dashboardIngress/labels",'\
'"value": "__<labels for a dashboard ingress>__"}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/customCheProperties/CHE_INFRA_KUBERNETES_INGRESS_LABELS", '\
'"value": "__<labels for a workspace ingress>__"}]'
----
. To configure annotations for {orch-ingress}, update the Custom Resource with the following commands:
+
IMPORTANT: Use object to specify annotations: `{"key1": "value1", "key2" : "value2"}`
+
[subs="+quotes,+attributes"]
----
$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/cheServerIngress/annotations", '\
'"value": __<annotations for a {prod-id-short} server ingress>__}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/auth/identityProviderIngress/annotations", '\
'"value": __<annotations for a {identity-provider} ingress>__}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/pluginRegistryIngress/annotations", '\
'"value": __<annotations for a plug-ins registry ingress>__}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/devfileRegistryIngress/annotations",'\
'"value": __<annotations for a devfile registry ingress>__}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/dashboardIngress/annotations",'\
'"value": __<annotations for a dashboard ingress>__}]'

$ {orch-cli} patch checluster/{prod-checluster} -n {prod-namespace} --type=json -p \
'[{"op": "replace", "path": "/spec/server/customCheProperties/CHE_INFRA_KUBERNETES_INGRESS_ANNOTATIONS______JSON", '\
'"value": "__<annotations for a workspace ingress in json format>__"}]'
----

This file was deleted.

Loading