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

fix: docs improvements #2675

Merged
merged 2 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The installation method depends on the target platform and the environment restr

.Using {prod-short} as a service

* link:https://www.eclipse.org/che/docs/che-7/hosted-che/hosted-che/[{prod-short} hosted by RedHat]
* link:https://www.eclipse.org/che/docs/stable/hosted-che/hosted-che/[{prod-short} hosted by RedHat]

.Installing {prod-short} in the cloud

Expand All @@ -13,12 +13,12 @@ You can deploy only one instance of {prod-short} per cluster.
* xref:installing-che-on-openshift-using-cli.adoc[]
* xref:installing-che-on-openshift-using-the-web-console.adoc[]
* xref:installing-che-in-a-restricted-environment.adoc[]

* xref:installing-che-on-microsoft-azure.adoc[]

.Installing {prod-short} on a local single-node cluster

Single-node clusters are suited only for testing or development. Do *not* use such clusters to run {prod-short} for organizations or developer teams.

* xref:installing-che-on-red-hat-openshift-local.adoc[]
* xref:installing-che-on-minikube.adoc[]

* xref:installing-che-on-minikube-keycloak-oidc.adoc[]
6 changes: 3 additions & 3 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@
*** xref:user-workspaces.adoc[]
** xref:calculating-che-resource-requirements.adoc[]
* xref:installing-che.adoc[]
** xref:installing-che-on-openshift-using-cli.adoc[]
** xref:installing-che-on-openshift-using-the-web-console.adoc[]
** xref:installing-che-in-a-restricted-environment.adoc[]
** xref:installing-che-in-the-cloud.adoc[]
*** xref:installing-che-on-openshift-using-cli.adoc[]
*** xref:installing-che-on-openshift-using-the-web-console.adoc[]
*** xref:installing-che-in-a-restricted-environment.adoc[]
*** xref:installing-che-on-microsoft-azure.adoc[]
** xref:installing-che-locally.adoc[]
*** xref:installing-che-on-red-hat-openshift-local.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,18 @@

You can get the fully qualified domain name (FQDN) of your organization's instance of {prod-short} on the command line or in the OpenShift web console.

TIP: You can find the FQDN for your organization's {prod-short} instance in the *Administrator* view of the OpenShift web console as follows. Go to *Operators* -> *OperatorHub* -> *Installed Operators* -> *{prod} instance Specification* -> *{prod-checluster}* -> *{prod} URL*.
TIP: You can find the FQDN for your organization's {prod-short} instance in the *Administrator* view of the OpenShift web console as follows. Go to *Operators* -> *Installed Operators* -> *{prod} instance Specification* -> *{prod-checluster}* -> *{prod} URL*.


.Prerequisites

* An active `oc` session with administrative permissions to the OpenShift cluster. See link:https://docs.openshift.com/container-platform/{ocp4-ver}/cli_reference/openshift_cli/getting-started-cli.html[Getting started with the OpenShift CLI].
* `{prod-cli}`. See xref:installing-the-chectl-management-tool.adoc[].

.Procedure

. Run the following command:
+
[subs="+attributes,+quotes"]
[source,bash,subs="+attributes,+quotes"]
----
$ {prod-cli} server:status
{orch-cli} get checluster {prod-checluster} -n {prod-namespace} -o jsonpath='{.status.cheURL}'
----
. Copy the *{prod} URL* without the trailing `/dashboard/`.
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,7 @@ Deploy and run {prod} in the cloud.

Follow the instructions below to start the {prod-short} Server in the cloud using the `{prod-cli}` tool.

* xref:installing-che-on-openshift-using-cli.adoc[]
* xref:installing-che-on-openshift-using-the-web-console.adoc[]
* xref:installing-che-in-a-restricted-environment.adoc[]
* xref:installing-che-on-microsoft-azure.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,10 @@ This section contains instructions for deploying and running {prod} locally, on

* `{prod-cli}`. See: xref:installing-the-chectl-management-tool.adoc[].

.Deploying {prod-short} on Minikube in 3 minutes using {prod-cli}
++++
<script id="asciicast-216201" src="https://asciinema.org/a/216201.js" async></script>
++++

== Deploying {prod-short} locally using {prod-cli}

Choose one of the following procedures to start the {prod-short} Server using the `{prod-cli}` tool.
Choose one of the following procedures to deploy the {prod-short} using the `{prod-cli}` tool.

* xref:installing-che-on-red-hat-openshift-local.adoc[]
* xref:installing-che-on-minikube.adoc[]
* xref:installing-che-on-minikube-keycloak-oidc.adoc[]
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
:_content-type: ASSEMBLY
:description: Installing and setting up {prod-short} on Microsoft Azure
:description: Installing {prod-short} on Microsoft Azure
:keywords: overview, installing-che-on-microsoft-azure
:navtitle: Installing and setting up {prod-short} on Microsoft Azure
tolusha marked this conversation as resolved.
Show resolved Hide resolved

[id="installing-{prod-id-short}-on-microsoft-azure"]
= Installing and setting up {prod-short} on Microsoft Azure
= Installing {prod-short} on Microsoft Azure

Microsoft Azure is a cloud computing service for building, testing, deploying, and managing applications and services through Microsoft-managed data centers.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,10 +44,11 @@ az network dns record-set a add-record \
If you use a registrar such as GoDaddy, you will need to add
the following two DNS records in your registrar and point them to the
IP address of the ingress controller:

* type: `A`
* names: `@` and `*`
====
+

.Additional resources

* link:https://learn.microsoft.com/en-us/azure/dns/dns-getstarted-cli[Create a Microsoft Azure DNS zone and record using Microsoft Azure CLI]
Original file line number Diff line number Diff line change
Expand Up @@ -103,10 +103,11 @@ EOF
[IMPORTANT]
====
If you use a registrar such as GoDaddy, you need to duplicate the following DNS records in your registrar:

* type: `TXT`
* name: `_acme-challenge`.
====
+

.Additional resources

* link:https://cert-manager.io/docs/tutorials/getting-started-aks-letsencrypt[Deploy cert-manager on Azure Kubernetes Service (AKS) and use Let's Encrypt to sign a certificate for an HTTPS website]
Expand Down
Loading