Skip to content

Commit

Permalink
chore: Update che-operator description
Browse files Browse the repository at this point in the history
Signed-off-by: Anatolii Bazko <abazko@redhat.com>
  • Loading branch information
tolusha committed Jan 10, 2022
1 parent bb3c53c commit b1a187e
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 46 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ metadata:
operators.operatorframework.io/project_layout: go.kubebuilder.io/v3
repository: https://github.com/eclipse-che/che-operator
support: Eclipse Foundation
name: eclipse-che-preview-openshift.v7.42.0-404.next
name: eclipse-che-preview-openshift.v7.42.0-406.next
namespace: placeholder
spec:
apiservicedefinitions: {}
Expand Down Expand Up @@ -375,36 +375,23 @@ spec:
version: v1
description: |
A collaborative Kubernetes-native development solution that delivers OpenShift workspaces and in-browser IDE for rapid cloud application development.
This operator installs PostgreSQL, Keycloak, Plugin registry, Devfile registry and the Eclipse Che server, as well as configures all three services.
This operator installs PostgreSQL, Plugin and Devfile registries, Dashboard, Gateway and the Eclipse Che server, as well as configures all these services.
OpenShift OAuth is used directly for authentication. TLS mode is on.
## How to Install
Press the **Install** button, choose the channel and the upgrade strategy, and wait for the **Installed** Operator status.
When the operator is installed, create a new CR of Kind CheCluster (click the **Create New** button).
The CR spec contains all defaults (see below).
You can start using Eclipse Che when the CR status is set to **Available**, and you see a URL to Eclipse Che.
When the operator is installed, create a new Custom Resource (CR) of Kind CheCluster (click the **Create New** button).
The CR spec contains all defaults. You can start using Eclipse Che when the CR status is set to **Available**, and you see a URL to Eclipse Che.
## Defaults
By default, the operator deploys Eclipse Che with:
* Bundled PostgreSQL and Keycloak
* Common PVC strategy
* 10Gi storage
* Auto-generated passwords
* TLS mode (secure routes)
* Communicate between components using internal cluster SVC names
* Regular login extended with OpenShift OAuth authentication
* Bundled PostgreSQL
* Bundled Plugin and Devfile registries
## Installation Options
Eclipse Che operator installation options include:
* Connection to external database and Keycloak
* Configuration of default passwords and object names
* PVC strategy (once shared PVC for all workspaces, PVC per workspace, or PVC per volume)
* Authentication options
Use `oc edit checluster/eclipse-che -n eclipse-che` to update Eclipse Che configuration.
See more configuration options in the [Installation guide](https://www.eclipse.org/che/docs/che-7/installation-guide/configuring-the-che-installation/).
### External Database and Keycloak
Follow the guides to configure external [Keycloak](https://www.eclipse.org/che/docs/che-7/administration-guide/configuring-authorization/#configuring-che-to-use-external-keycloak_che)
and [Database](https://www.eclipse.org/che/docs/che-7/administration-guide/external-database-setup/) setup.
Use `oc edit checluster/eclipse-che -n eclipse-che` to update Eclipse Che default installation options.
See more in the [Installation guide](https://www.eclipse.org/che/docs/che-7/installation-guide/configuring-the-che-installation/).
### Certificates
Operator uses a default router certificate to secure Eclipse Che routes.
Expand Down Expand Up @@ -1456,4 +1443,4 @@ spec:
maturity: stable
provider:
name: Eclipse Foundation
version: 7.42.0-404.next
version: 7.42.0-406.next
Original file line number Diff line number Diff line change
Expand Up @@ -14,36 +14,23 @@
path: /spec/description
value: |
A collaborative Kubernetes-native development solution that delivers OpenShift workspaces and in-browser IDE for rapid cloud application development.
This operator installs PostgreSQL, Keycloak, Plugin registry, Devfile registry and the Eclipse Che server, as well as configures all three services.
This operator installs PostgreSQL, Plugin and Devfile registries, Dashboard, Gateway and the Eclipse Che server, as well as configures all these services.
OpenShift OAuth is used directly for authentication. TLS mode is on.
## How to Install
Press the **Install** button, choose the channel and the upgrade strategy, and wait for the **Installed** Operator status.
When the operator is installed, create a new CR of Kind CheCluster (click the **Create New** button).
The CR spec contains all defaults (see below).
You can start using Eclipse Che when the CR status is set to **Available**, and you see a URL to Eclipse Che.
When the operator is installed, create a new Custom Resource (CR) of Kind CheCluster (click the **Create New** button).
The CR spec contains all defaults. You can start using Eclipse Che when the CR status is set to **Available**, and you see a URL to Eclipse Che.
## Defaults
By default, the operator deploys Eclipse Che with:
* Bundled PostgreSQL and Keycloak
* Common PVC strategy
* 10Gi storage
* Auto-generated passwords
* TLS mode (secure routes)
* Communicate between components using internal cluster SVC names
* Regular login extended with OpenShift OAuth authentication
* Bundled PostgreSQL
* Bundled Plugin and Devfile registries
## Installation Options
Eclipse Che operator installation options include:
* Connection to external database and Keycloak
* Configuration of default passwords and object names
* PVC strategy (once shared PVC for all workspaces, PVC per workspace, or PVC per volume)
* Authentication options
Use `oc edit checluster/eclipse-che -n eclipse-che` to update Eclipse Che configuration.
See more configuration options in the [Installation guide](https://www.eclipse.org/che/docs/che-7/installation-guide/configuring-the-che-installation/).
### External Database and Keycloak
Follow the guides to configure external [Keycloak](https://www.eclipse.org/che/docs/che-7/administration-guide/configuring-authorization/#configuring-che-to-use-external-keycloak_che)
and [Database](https://www.eclipse.org/che/docs/che-7/administration-guide/external-database-setup/) setup.
Use `oc edit checluster/eclipse-che -n eclipse-che` to update Eclipse Che default installation options.
See more in the [Installation guide](https://www.eclipse.org/che/docs/che-7/installation-guide/configuring-the-che-installation/).
### Certificates
Operator uses a default router certificate to secure Eclipse Che routes.
Expand Down

0 comments on commit b1a187e

Please sign in to comment.