Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
2 changes: 1 addition & 1 deletion modules/install/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -23,10 +23,10 @@
** Deploy in a restricted environment
*** xref:proc_installing-che-in-a-restricted-environment.adoc[]
** xref:using-chectl-to-configure-the-checluster-custom-resource-during-installation.adoc[]
** xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
** Permissions
*** xref:ref_permissions-to-install-che-on-openshift-using-cli.adoc[]
*** xref:ref_permissions-to-install-che-on-openshift-using-the-web-console.adoc[]
* xref:proc_verifying-the-installation.adoc[]
* xref:proc_finding-the-fully-qualified-domain-name-fqdn.adoc[]
* xref:con_next-steps-after-installation.adoc[]
* xref:proc_uninstalling-che.adoc[]
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_content-type: PROCEDURE
:description: Calculate the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces. Accurate resource estimates ensure your cluster can handle the expected number of concurrent users without performance issues.
:description: Size your cluster by calculating the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces so that your cluster can handle the expected number of concurrent users.
:keywords: install, calculating-che-resource-requirements
:navtitle: Calculate {prod-short} resource requirements
:navtitle: Size your cluster for {prod-short}
:page-aliases: administration-guide:calculating-che-resource-requirements.adoc, plan:calculating-che-resource-requirements.adoc


[id="calculating-{prod-id-short}-resource-requirements"]
= Calculate {prod-short} resource requirements
= Size your cluster for {prod-short}

[role="_abstract"]
Calculate the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces. Accurate resource estimates ensure your cluster can handle the expected number of concurrent users without performance issues.
Size your cluster by calculating the CPU and memory requirements for the {prod-short} Operator, {devworkspace} Controller, and user workspaces so that your cluster can handle the expected number of concurrent users.

The {prod-short} Operator, {devworkspace} Controller, and user workspaces consist of a set of pods.
The pods contribute to the resource consumption in CPU and memory limits and requests.
Expand Down
25 changes: 13 additions & 12 deletions modules/install/pages/con_installation-overview.adoc
Original file line number Diff line number Diff line change
@@ -1,32 +1,33 @@
:_content-type: CONCEPT
:description: {prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose — CLI or web console — depends on your cluster environment, security requirements, and need for configuration control.
:description: {prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose depends on your cluster environment and need for configuration control.
:keywords: install, overview, deployment, operator
:navtitle: {prod-short} installation overview
:navtitle: How the installation works

[id="con_installation-overview"]
= {prod-short} installation overview
= How the installation works

[role="_abstract"]
{prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose — CLI or web console — depends on your cluster environment, security requirements, and need for configuration control.
{prod-short} deploys on {orch-name} as an Operator that manages a gateway, dashboard, server, and plug-in registry. The installation method you choose depends on your cluster environment and need for configuration control.

{prod-short} consists of an Operator, a user dashboard, a gateway, and a plug-in registry. The Operator manages the full lifecycle of all server components. You deploy {prod-short} by installing the Operator and creating a `CheCluster` custom resource.

== Installation methods
== Which installation method should I use?

{prod-short} supports two installation methods:
`{prod-cli}` command-line tool:: Choose this method when you need to quickly deploy {prod-short} for evaluation, customize the `CheCluster` configuration during installation, or manage {prod-short} from scripts.

`{prod-cli}` command-line tool:: Install and manage {prod-short} from the command line. This method provides the most control over the installation process and supports advanced configuration options during deployment.
{orch-name} web console:: Choose this method when you prefer a graphical workflow through OperatorHub and do not need advanced configuration options during deployment.

{orch-name} web console:: Install the {prod} Operator from OperatorHub and create a `CheCluster` instance through the web console. This method uses the standard {orch-name} Operator installation workflow.
Both methods produce the same result: an Operator subscription and a `CheCluster` custom resource. For step-by-step deployment instructions, see Additional resources.

== Deployment scenarios
== Which deployment scenario matches my environment?

Standard installation:: Deploy {prod-short} on an {orch-name} cluster with internet access. Both the CLI and web console methods are available.
Standard deployment:: Your {orch-name} cluster has internet access. Both installation methods are available. The Operator pulls container images directly from `registry.redhat.io`.

Restricted environment:: Deploy {prod-short} on an air-gapped or disconnected {orch-name} cluster. This scenario requires mirroring container images to a private registry before installation.
Air-gapped deployment:: Your cluster has no internet access. Mirror the required container images and Operator catalogs to a private registry before installation.

External identity provider:: Deploy {prod-short} with {keycloak} as an external OpenID Connect (OIDC) identity provider instead of the default {orch-name} OAuth. This scenario applies when you need to integrate with an existing identity management system.
External identity provider:: Your organization manages authentication through an existing identity system such as {keycloak}. Deploy {prod-short} with an external OIDC provider instead of the default {orch-name} OAuth.

[role="_additional-resources"]
.Additional resources

* xref:proc_installing-che-on-openshift-using-cli.adoc[]
Expand Down
14 changes: 7 additions & 7 deletions modules/install/pages/con_next-steps-after-installation.adoc
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
:_content-type: CONCEPT
:description: After a successful installation, configure the CheCluster resource, connect Git providers, and create your first workspace.
:description: Prepare {prod-short} for your team by completing these configuration tasks before inviting developers: customize the CheCluster resource, connect Git providers, and verify end-to-end functionality with a first workspace.
:keywords: install, next steps, configuration, post-install
:navtitle: Next steps after installation
:navtitle: Prepare {prod-short} for your team

[id="con_next-steps-after-installation"]
= Next steps after installation
= Prepare {prod-short} for your team

[role="_abstract"]
After a successful installation, a few configuration tasks remain before your team can start using {prod-short} — customizing the `CheCluster` resource, connecting Git providers, and verifying end-to-end functionality with a first workspace.
Prepare {prod-short} for your team by completing these configuration tasks before inviting developers: customize the `CheCluster` resource, connect Git providers for credential-free repository access, and verify end-to-end functionality with a first workspace.

* Configure the `CheCluster` custom resource to customize {prod-short} behavior.
* Configure OAuth for Git providers so that users can interact with remote Git repositories.
* Create your first workspace from a Git repository URL.
* Verify the platform end-to-end, configure Git provider OAuth, and share the dashboard URL with developers.
* Customize the `CheCluster` custom resource to adjust {prod-short} behavior for your environment.
* Create your first cloud development environment from a Git repository URL.

.Additional resources

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
:_content-type: ASSEMBLY
:description: Install {prod-cli}, the {prod} CLI management tool, on Linux, macOS, or Windows. The {prod-cli} tool lets you deploy, update, and manage {prod-short} from the command line.
:description: Set up {prod-cli} on Linux, macOS, or Windows so that you can deploy, update, and manage {prod-short} from the command line.
:keywords: install, installing-the-chectl-management-tool
:navtitle: Install the {prod-cli} management tool
:navtitle: Set up the {prod-cli} command-line tool
:page-aliases: administration-guide:installing-the-chectl-management-tool.adoc, plan:installing-the-chectl-management-tool.adoc, installation-guide:using-the-chectl-management-tool.adoc, overview:using-the-chectl-management-tool.adoc, using-the-chectl-management-tool.adoc


[id="installing-the-{prod-cli}-management-tool"]
= Install the {prod-cli} management tool
= Set up the {prod-cli} command-line tool

[role="_abstract"]
Install `{prod-cli}`, the {prod} CLI management tool, on Linux, macOS, or Windows. The `{prod-cli}` tool lets you deploy, update, and manage {prod-short} from the command line.
Set up `{prod-cli}` on Linux, macOS, or Windows so that you can deploy, update, and manage {prod-short} from the command line.

include::example$proc_{project-context}-installing-the-chectl-management-tool-on-windows.adoc[leveloffset=+1]

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: PROCEDURE
:description: Retrieve the {prod-short} dashboard URL from the CheCluster custom resource. You need this URL to open the dashboard in a browser or share the endpoint with your development team.
:description: Get the {prod-short} dashboard URL from the CheCluster custom resource so that you can open the dashboard in a browser or share the endpoint with your development team.
:keywords: fqdn, domain, url, dashboard
:navtitle: Find the FQDN
:navtitle: Get the dashboard URL to share with your team
:page-aliases: finding-the-fully-qualified-domain-name-fqdn.adoc

[id="proc_finding-the-fully-qualified-domain-name-fqdn"]
= Find the fully qualified domain name (FQDN)
= Get the dashboard URL to share with your team

[role="_abstract"]
Retrieve the {prod-short} dashboard URL from the `CheCluster` custom resource. You need this URL to open the dashboard in a browser or share the endpoint with your development team.
Get the {prod-short} dashboard URL from the `CheCluster` custom resource so that you can open the dashboard in a browser or share the endpoint with your development team.

[TIP]
====
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: PROCEDURE
:description: Deploy {prod-short} on an air-gapped {orch-name} cluster by mirroring the required container images and Operator catalogs to a private registry. This procedure covers the additional steps needed when the cluster has no direct internet access.
:description: Deploy {prod-short} on an {orch-name} cluster with no internet access by mirroring the required container images and Operator catalogs to a private registry.
:keywords: install, restricted, air-gapped, disconnected, openshift
:navtitle: Install {prod-short} in a restricted environment
:navtitle: Deploy in an air-gapped environment
:page-aliases: installation-guide:installing-che-in-restricted-environment.adoc, installation-guide:installing-che-in-a-restricted-environment.adoc, preparing-a-restricted-environment.adoc, configuring-che-to-run-in-a-restricted-environment.adoc, installing-che-in-a-restricted-environment.adoc

[id="proc_installing-che-in-a-restricted-environment"]
= Install {prod-short} in a restricted environment on {orch-name}
= Deploy in an air-gapped environment

[role="_abstract"]
Deploy {prod-short} on an air-gapped {orch-name} cluster by mirroring the required container images and Operator catalogs to a private registry. This procedure covers the additional steps needed when the cluster has no direct internet access.
Deploy {prod-short} on an {orch-name} cluster with no internet access by mirroring the required container images and Operator catalogs to a private registry.

On a restricted network, deploying {prod-short} and running workspaces requires the following public resources:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,10 @@ minikube start \

. Configure Keycloak to create the realm, client, and user:
+
IMPORTANT: Repeat this step each time you start the Minikube cluster.
[IMPORTANT]
====
Repeat this step each time you start the Minikube cluster.
====
+
[source,bash,subs="+attributes"]
----
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: PROCEDURE
:description: Install the {prod-short} Operator and create a CheCluster instance from the command line by using the {prod-cli} management tool. The CLI method provides full control over configuration options during deployment.
:description: Deploy {prod-short} from the command line using the {prod-cli} management tool so that you have full control over configuration options and can automate the installation.
:keywords: install, openshift, cli, chectl
:navtitle: Install {prod-short} on OpenShift using CLI
:navtitle: Deploy using the CLI
:page-aliases: installation-guide:installing-che-on-openshift-4-using-cli.adoc, overview:installing-che-on-openshift-4-using-cli.adoc, installing-che-on-openshift-4-using-cli.adoc, installing-che-on-openshift-using-cli.adoc

[id="proc_installing-che-on-openshift-using-cli"]
= Install {prod-short} on OpenShift using CLI
= Deploy using the CLI

[role="_abstract"]
Install the {prod-short} Operator and create a `CheCluster` instance from the command line by using the `{prod-cli}` management tool. The CLI method provides full control over configuration options during deployment.
Deploy {prod-short} from the command line using the `{prod-cli}` management tool so that you have full control over configuration options and can automate the installation.

.Prerequisites

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: PROCEDURE
:description: Deploy the {prod} Operator from OperatorHub and create a CheCluster instance through the {orch-name} web console. This method uses the standard Operator workflow and is suitable when you do not need advanced CLI configuration options.
:description: Deploy {prod-short} through the {orch-name} web console using the standard OperatorHub workflow so that you can install without command-line access.
:keywords: install, openshift, web console, operatorhub
:navtitle: Install {prod-short} on OpenShift using the web console
:navtitle: Deploy using the web console
:page-aliases: installation-guide:installing-che-on-openshift-4-using-operatorhub.adoc, overview:installing-che-on-openshift-4-using-operatorhub.adoc, creating-an-instance-of-the-che-operator.adoc, installing-che-on-openshift-4-using-operatorhub.adoc, installing-che-on-openshift-using-the-web-console.adoc

[id="proc_installing-che-on-openshift-using-the-web-console"]
= Install {prod-short} on OpenShift using the web console
= Deploy using the web console

[role="_abstract"]
Deploy the {prod} Operator from OperatorHub and create a `CheCluster` instance through the {orch-name} web console. This method uses the standard Operator workflow and is suitable when you do not need advanced CLI configuration options.
Deploy {prod-short} through the {orch-name} web console using the standard OperatorHub workflow so that you can install without command-line access.

.Prerequisites

Expand Down Expand Up @@ -59,11 +59,11 @@ See link:https://docs.openshift.com/container-platform/{ocp4-ver}/operators/user

.Verification

pass:[<!-- vale RedHat.Spelling = NO -->]
// vale RedHat.Spelling = NO

. In *{prod} instance Specification*, go to *{prod-checluster}*, landing on the *Details* tab.

pass:[<!-- vale RedHat.Spelling = YES -->]
// vale RedHat.Spelling = YES

. Under *Message*, check that there is *None*, which means no errors.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
:_content-type: PROCEDURE
:description: To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider.
:description: Deploy {prod-short} with {keycloak} as the OIDC provider so that you can manage user authentication through your organization's existing identity infrastructure instead of {orch-name} OAuth.
:keywords: install, openshift, keycloak, oidc, identity provider
:navtitle: Install {prod-short} on OpenShift with {keycloak} as external identity provider
:navtitle: Deploy using an external identity provider
:page-aliases: installing-che-on-openshift-with-keycloak-as-oidc.adoc

[id="proc_installing-che-on-openshift-with-keycloak-as-oidc"]
= Install {prod-short} on OpenShift with {keycloak} as external identity provider
= Deploy using an external identity provider

[role="_abstract"]
To enable centralized user authentication through an external identity provider, install {prod-short} on {orch-name} with {keycloak} as the OIDC provider.
Deploy {prod-short} with {keycloak} as the OIDC provider so that you can manage user authentication through your organization's existing identity infrastructure instead of {orch-name} OAuth.

.Prerequisites

Expand Down Expand Up @@ -36,16 +36,19 @@ To enable centralized user authentication through an external identity provider,
+
... Enter `{prod-short}` redirect URL in the *Valid redirect URIs* field.
+
NOTE: Run the following command to obtain the `{prod}` redirect URL:
+
[NOTE]
====
Run the following command to obtain the `{prod}` redirect URL:

[source,bash,subs="+quotes,+attributes"]
----
echo "$(
oc whoami --show-console |
sed 's|console-openshift-console|{prod-id}|g'
)/oauth/callback"
----

====
+
... Click *Save*.

.. Navigate to the *Credentials* tab of the newly created client and copy the *Client secret* value for use when applying the OAuth client secret.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ To evaluate {prod-short} on a local {orch-name} cluster, deploy {prod-short} by

.Prerequisites

* You have an active `{orch-cli}` session with administrative permissions to the {orch-name} 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].

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

* You have a running instance of {rh-os-local}. See link:https://developers.redhat.com/products/openshift-local/overview[{rh-os-local} overview].
Expand Down Expand Up @@ -45,7 +47,10 @@ $ crc setup
$ crc start --memory 12288 --disk-size=64 --pull-secret-file __<pull_secret_file>__
----
+
NOTE: Take note of the password for the `kubeadmin` user displayed at the end of the {rh-os-local} initiation.
[NOTE]
====
Take note of the password for the `kubeadmin` user displayed at the end of the {rh-os-local} initiation.
====

. Enable access to the `oc` command line interface embedded in {rh-os-local}:
+
Expand Down
Loading
Loading