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

feat: Remove PostgreSQL component #2561

Merged
merged 1 commit into from
Mar 2, 2023
Merged
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
1 change: 0 additions & 1 deletion antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@ asciidoc:
platforms-ingress: Kubernetes Ingress or OpenShift Route
platforms-name: Kubernetes or OpenShift
platforms-namespace: Kubernetes namespace or OpenShift project
postgresql-image-url: quay.io/eclipse/che--centos--postgresql-96-centos13
pre-migration-prod-checluster: eclipse-che
pre-migration-prod-deployment: che
pre-migration-prod-id-short: che
Expand Down

This file was deleted.

1 change: 0 additions & 1 deletion modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
**** xref:dashboard.adoc[]
**** xref:devfile-registries.adoc[]
**** xref:che-server.adoc[]
**** xref:postgresql.adoc[]
**** xref:plugin-registry.adoc[]
*** xref:user-workspaces.adoc[]
** xref:calculating-che-resource-requirements.adoc[]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
:description: High-level {prod-short} architecture
:keywords: administration-guide, architecture
:navtitle: Architecture
:page-aliases: .:che-architecture-overview.adoc, .:high-level-che-architecture.adoc, overview:high-level-che-architecture.adoc, administration-guide:high-level-che-architecture.adoc, che-architecture-overview.adoc, .:che-architecture-overview-with-che-server.adoc, .:high-level-che-architecture-with-che-server.adoc, overview:high-level-che-architecture-with-che-server.adoc, administration-guide:high-level-che-architecture-with-che-server.adoc, .:che-architecture-overview-with-devworkspace.adoc, .:high-level-che-architecture-with-devworkspace.adoc, overview:high-level-che-architecture-with-devworkspace.adoc, administration-guide:high-level-che-architecture-with-devworkspace.adoc, architecture-overview-with-devworkspace.adoc, architecture-overview-with-che-server, server-components-with-che-server.adoc, che-workspaces-architecture-with-che-server.adoc, backup-and-recovery.adoc, supported-restic-compatible-backup-servers.adoc, backing-up-of-che-instances-to-an-sftp-backup-server.adoc, backing-up-of-che-instances-to-amazon-s3.adoc, backing-up-of-che-instances-to-a-rest-backup-server.adoc, backing-up-of-che-instances-to-the-internal-backup-server.adoc, restoring-a-che-instance-from-a-backup.adoc, backups-of-persistent-volumes.adoc, backups-of-postgresql.adoc, migration-from-postgresql-9-to-postgresql-13.adoc, readiness-init-containers.adoc, enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-readiness-init-containers-for-the-operator-installer.adoc, disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc, enabling-readiness-init-containers-for-the-olm-installer.adoc, disabling-readiness-init-containers-for-the-olm-installer.adoc, overview:architecture-overview.adoc, overview:che-architecture.adoc
:page-aliases: .:che-architecture-overview.adoc, .:high-level-che-architecture.adoc, overview:high-level-che-architecture.adoc, administration-guide:high-level-che-architecture.adoc, che-architecture-overview.adoc, .:che-architecture-overview-with-che-server.adoc, .:high-level-che-architecture-with-che-server.adoc, overview:high-level-che-architecture-with-che-server.adoc, administration-guide:high-level-che-architecture-with-che-server.adoc, .:che-architecture-overview-with-devworkspace.adoc, .:high-level-che-architecture-with-devworkspace.adoc, overview:high-level-che-architecture-with-devworkspace.adoc, administration-guide:high-level-che-architecture-with-devworkspace.adoc, architecture-overview-with-devworkspace.adoc, architecture-overview-with-che-server, server-components-with-che-server.adoc, che-workspaces-architecture-with-che-server.adoc, backup-and-recovery.adoc, supported-restic-compatible-backup-servers.adoc, backing-up-of-che-instances-to-an-sftp-backup-server.adoc, backing-up-of-che-instances-to-amazon-s3.adoc, backing-up-of-che-instances-to-a-rest-backup-server.adoc, backing-up-of-che-instances-to-the-internal-backup-server.adoc, restoring-a-che-instance-from-a-backup.adoc, backups-of-persistent-volumes.adoc, readiness-init-containers.adoc, enabling-and-disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-readiness-init-containers-for-the-operator-installer.adoc, disabling-readiness-init-containers-for-the-operator-installer.adoc, enabling-and-disabling-readiness-init-containers-for-the-olm-installer.adoc, enabling-readiness-init-containers-for-the-olm-installer.adoc, disabling-readiness-init-containers-for-the-olm-installer.adoc, overview:architecture-overview.adoc, overview:che-architecture.adoc

[id="architecture"]
= {prod-short} architecture
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,14 +173,6 @@ When this section is empty, {prod-short} only loads the implicit components.
|500 m
|100 m

|PostgreSQL database
|`postgres`
|`postgres`
|1 Gi
|512 Mi
|500 m
|100 m

|{devworkspace} Controller Manager
|`{devworkspace-id}-controller-manager`
|`{devworkspace-id}-controller`
Expand Down Expand Up @@ -230,9 +222,9 @@ When this section is empty, {prod-short} only loads the implicit components.
|N/A

3+>s|Total
>s|9.5 GiB
>s|1.6 GiB
>s|7.4
>s|2.31
>s|8.5 GiB
>s|1.1 GiB
>s|6.9
>s|2.21

|===
1 change: 0 additions & 1 deletion modules/administration-guide/pages/che-operator.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@ On a cluster with the {prod-short} operator, it is possible to create a `CheClus
* xref:dashboard.adoc[]
* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:postgresql.adoc[]
* xref:plugin-registry.adoc[]

.Additional resources
Expand Down
1 change: 0 additions & 1 deletion modules/administration-guide/pages/che-server.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ The {prod-short} server main functions are:

The {prod-short} server is a Java web service exposing an HTTP REST API and needs access to:

* xref:postgresql.adoc[]
* Git service providers
* {orch-name} API

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ This section describes all fields available to customize the `CheCluster` Custom
* xref:checluster-custom-resource-components-properties-cheServer-settings[]
* xref:checluster-custom-resource-components-properties-pluginRegistry-settings[]
* xref:checluster-custom-resource-components-properties-devfileRegistry-settings[]
* xref:checluster-custom-resource-components-properties-database-settings[]
* xref:checluster-custom-resource-components-properties-dashboard-settings[]
* xref:checluster-custom-resource-components-properties-imagePuller-settings[]
* xref:checluster-custom-resource-components-properties-metrics-settings[]
Expand All @@ -40,8 +39,6 @@ spec:
storage:
pvcStrategy: 'common'
components:
database:
externalDb: false
metrics:
enable: true
----
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,9 @@ To configure {prod-short} to use a configured infrastructure storage, install {p
* A storage type
* And many others

{prod-short} has two components that require persistent volumes to store data:
{prod-short} has one component that requires persistent volumes to store data:

* A PostgreSQL database.
* A {prod-short} workspaces. {prod-short} workspaces store source code using volumes, for example `/projects` volume.
* A {prod-short} workspace. {prod-short} workspaces store source code using volumes, for example `/projects` volume.

[NOTE]
====
Expand All @@ -45,40 +44,14 @@ Use CheCluster Custom Resource definition to define storage classes:
[source,yaml,subs="+quotes,+attributes"]
----
spec:
components:
database:
pvc:
# keep blank unless you need to use a non default storage class for PostgreSQL PVC
storageClass: 'postgres-storage'
devEnvironments:
storage:
pvc:
# keep blank unless you need to use a non default storage class for workspace PVC(s)
storageClass: 'workspace-storage'
----

. Define the persistent volume for a PostgreSQL database in a `che-postgres-pv.yaml` file:
+
.`che-postgres-pv.yaml` file
[source,yaml]
----
apiVersion: v1
kind: PersistentVolume
metadata:
name: postgres-pv-volume
labels:
type: local
spec:
storageClassName: postgres-storage
capacity:
storage: 1Gi
accessModes:
- ReadWriteOnce
hostPath:
path: "/data/che/postgres"
----

. Define the persistent volume for a {prod-short} workspace in a `che-postgres-pv.yaml` file:
. Define the persistent volume for a {prod-short} workspace in a `che-workspace-pv.yaml` file:
+
.`che-workspace-pv.yaml` file
[source,yaml]
Expand All @@ -99,16 +72,16 @@ spec:
path: "/data/che/workspace"
----

. Bind the two persistent volumes:
. Bind the persistent volume:
+
[subs="+quotes,+attributes"]
----
$ kubectl apply -f che-workspace-pv.yaml -f che-postgres-pv.yaml
$ kubectl apply -f che-workspace-pv.yaml
----

[NOTE]
====
You must provide valid file permissions for volumes. You can do it using storage class configuration or manually. To manually define permissions, define `storageClass#mountOptions` `uid` and `gid`. PostgreSQL volume requires `uid=26` and `gid=26`.
You must provide valid file permissions for volumes. You can do it using storage class configuration or manually. To manually define permissions, define `storageClass#mountOptions` `uid` and `gid`.
====

.Additional resources
Expand Down
20 changes: 0 additions & 20 deletions modules/administration-guide/pages/postgresql.adoc

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,4 @@ image::architecture/{project-context}-deployments-interacting-with-devworkspace.
* xref:dashboard.adoc[]
* xref:devfile-registries.adoc[]
* xref:che-server.adoc[]
* xref:postgresql.adoc[]
* xref:plugin-registry.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

A default deployment of {prod-short} consists of a `CheCluster` Custom Resource parameterized by the {prod} Operator.

The `CheCluster` Custom Resource is a {kubernetes} object. You can configure it by editing the `CheCluster` Custom Resource YAML file. This file contains sections to configure each component: `devWorkspace`, `cheServer`, `pluginRegistry`, `devfileRegistry`, `database`, `dashboard` and `imagePuller`.
The `CheCluster` Custom Resource is a {kubernetes} object. You can configure it by editing the `CheCluster` Custom Resource YAML file. This file contains sections to configure each component: `devWorkspace`, `cheServer`, `pluginRegistry`, `devfileRegistry`, `dashboard` and `imagePuller`.

The {prod} Operator translates the `CheCluster` Custom Resource into a config map usable by each component of the {prod-short} installation.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,6 @@
+
* The `<DEPLOYMENT_NAME>` corresponds to the one following deployments:

** `postgres`
** `keycloak`
** `devfile-registry`
** `plugin-registry`
Expand Down
1 change: 0 additions & 1 deletion tools/checluster_docs_gen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,6 @@ parse_content() {
parse_section "components.properties.cheServer" "General configuration settings related to the {prod-short} server component."
parse_section "components.properties.pluginRegistry" "Configuration settings related to the Plug-in registry component used by the {prod-short} installation."
parse_section "components.properties.devfileRegistry" "Configuration settings related to the Devfile registry component used by the {prod-short} installation."
parse_section "components.properties.database" "Configuration settings related to the Database component used by the {prod-short} installation."
parse_section "components.properties.dashboard" "Configuration settings related to the Dashboard component used by the {prod-short} installation."
parse_section "components.properties.imagePuller" "Kubernetes Image Puller component configuration."
parse_section "components.properties.metrics" "{prod-short} server metrics component configuration."
Expand Down
9 changes: 0 additions & 9 deletions tools/create_architecture_diagrams.py
Original file line number Diff line number Diff line change
Expand Up @@ -115,15 +115,6 @@ def architecture_diagrams(prod_short, project_context, orchestrator_name):
che_host >> crd_workspace
che_host >> postgres

filename = file_path + 'postgresql-interactions'
with Diagram(filename=filename,
show=False,
direction="TB",
graph_attr=graph_attr):
che_host = Custom(prod_short + ' server', icon_path=prod_icon)
postgres = PostgreSQL('PostgreSQL')
che_host >> postgres

filename = file_path + 'devfile-registry-interactions'
with Diagram(filename=filename,
show=False,
Expand Down