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.

Sign up for GitHub

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

Jump to bottom

chore: Update che-operator description #1283

Merged
merged 1 commit into from
Jan 11, 2022
Merged

chore: Update che-operator description #1283

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
35 changes: 11 additions & 24 deletions bundle/next/eclipse-che-preview-openshift/manifests/che-operator.clusterserviceversion.yaml
View file
Open in desktop
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

TLS mode is on

Do we still support non TLS mode? If no, maybe just drop the phrase or say that it just uses HTTPS for external routes.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't support non TLS mode. I've added this phrase just to emphasize


## 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
31 changes: 9 additions & 22 deletions config/platforms/openshift/che-operator.clusterserviceversion-description-patch.yaml
View file
Open in desktop
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