From c198158f4d87e9950c2db85f6bb46212bbcffc59 Mon Sep 17 00:00:00 2001 From: Anatolii Bazko Date: Thu, 23 Feb 2023 13:04:08 +0200 Subject: [PATCH] feat: Remove PostgreSQL component Signed-off-by: Anatolii Bazko --- antora.yml | 1 - ...p_che-postgresql-additional-resources.adoc | 4 -- modules/administration-guide/nav.adoc | 1 - .../pages/architecture-overview.adoc | 2 +- ...calculating-che-resource-requirements.adoc | 16 ++------ .../pages/che-operator.adoc | 1 - .../pages/che-server.adoc | 1 - ...ster-custom-resource-fields-reference.adoc | 3 -- .../installing-che-using-storage-classes.adoc | 39 +++---------------- .../pages/postgresql.adoc | 20 ---------- .../pages/server-components.adoc | 1 - ...anding-the-checluster-custom-resource.adoc | 2 +- ...ecret-or-a-configmap-into-a-container.adoc | 1 - tools/checluster_docs_gen.sh | 1 - tools/create_architecture_diagrams.py | 9 ----- 15 files changed, 12 insertions(+), 90 deletions(-) delete mode 100644 modules/administration-guide/examples/snip_che-postgresql-additional-resources.adoc delete mode 100644 modules/administration-guide/pages/postgresql.adoc diff --git a/antora.yml b/antora.yml index 84e8f2894d..803c432e80 100644 --- a/antora.yml +++ b/antora.yml @@ -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 diff --git a/modules/administration-guide/examples/snip_che-postgresql-additional-resources.adoc b/modules/administration-guide/examples/snip_che-postgresql-additional-resources.adoc deleted file mode 100644 index 95d2dbed9a..0000000000 --- a/modules/administration-guide/examples/snip_che-postgresql-additional-resources.adoc +++ /dev/null @@ -1,4 +0,0 @@ -:_content-type: SNIPPET - -* link:https://quay.io/repository/eclipse/che--centos--postgresql-96-centos7?tab=history[`quay.io/eclipse/che--centos--postgresql-96-centos7` container image] -* link:https://quay.io/repository/eclipse/che--centos--postgresql-13-centos7?tab=history[`quay.io/eclipse/che--centos--postgresql-13-centos7` container image] diff --git a/modules/administration-guide/nav.adoc b/modules/administration-guide/nav.adoc index 0c3b73dbb5..e0697c30d7 100644 --- a/modules/administration-guide/nav.adoc +++ b/modules/administration-guide/nav.adoc @@ -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[] diff --git a/modules/administration-guide/pages/architecture-overview.adoc b/modules/administration-guide/pages/architecture-overview.adoc index 08d338dd96..7b237ee9f9 100644 --- a/modules/administration-guide/pages/architecture-overview.adoc +++ b/modules/administration-guide/pages/architecture-overview.adoc @@ -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 diff --git a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc b/modules/administration-guide/pages/calculating-che-resource-requirements.adoc index c64f953222..085cc960a8 100644 --- a/modules/administration-guide/pages/calculating-che-resource-requirements.adoc +++ b/modules/administration-guide/pages/calculating-che-resource-requirements.adoc @@ -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` @@ -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 |=== diff --git a/modules/administration-guide/pages/che-operator.adoc b/modules/administration-guide/pages/che-operator.adoc index e51dc23e35..7085616cf6 100644 --- a/modules/administration-guide/pages/che-operator.adoc +++ b/modules/administration-guide/pages/che-operator.adoc @@ -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 diff --git a/modules/administration-guide/pages/che-server.adoc b/modules/administration-guide/pages/che-server.adoc index 353ecb9c46..22d5f9e9b9 100644 --- a/modules/administration-guide/pages/che-server.adoc +++ b/modules/administration-guide/pages/che-server.adoc @@ -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 diff --git a/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc b/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc index 61eb22a8fd..0eb6c388f5 100644 --- a/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc +++ b/modules/administration-guide/pages/checluster-custom-resource-fields-reference.adoc @@ -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[] @@ -40,8 +39,6 @@ spec: storage: pvcStrategy: 'common' components: - database: - externalDb: false metrics: enable: true ---- diff --git a/modules/administration-guide/pages/installing-che-using-storage-classes.adoc b/modules/administration-guide/pages/installing-che-using-storage-classes.adoc index 0ecd6845a7..acfff3e9f9 100644 --- a/modules/administration-guide/pages/installing-che-using-storage-classes.adoc +++ b/modules/administration-guide/pages/installing-che-using-storage-classes.adoc @@ -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] ==== @@ -45,11 +44,6 @@ 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: @@ -57,28 +51,7 @@ spec: 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] @@ -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 diff --git a/modules/administration-guide/pages/postgresql.adoc b/modules/administration-guide/pages/postgresql.adoc deleted file mode 100644 index e7b462f801..0000000000 --- a/modules/administration-guide/pages/postgresql.adoc +++ /dev/null @@ -1,20 +0,0 @@ -:_content-type: ASSEMBLY -:description: PostgreSQL -:keywords: administration-guide, architecture, server, devworkspace, postgresql, database -:navtitle: PostgreSQL -:page-aliases: - -[id="postgresql"] -= PostgreSQL - -{prod-short} server uses the PostgreSQL database to persist user configurations such as workspaces metadata. - -The {prod-short} deployment starts a dedicated PostgreSQL instance in the `postgres` Deployment. -You can use an external database instead. - -.PostgreSQL interactions with other components -image::architecture/{project-context}-postgresql-interactions.png[PostgreSQL interactions with other components] - -.Additional resources - -include::example$snip_che-postgresql-additional-resources.adoc[] diff --git a/modules/administration-guide/pages/server-components.adoc b/modules/administration-guide/pages/server-components.adoc index 6cfb548e3f..82e7015e99 100644 --- a/modules/administration-guide/pages/server-components.adoc +++ b/modules/administration-guide/pages/server-components.adoc @@ -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[] diff --git a/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc b/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc index 75ac3e77bb..2b4f043b24 100644 --- a/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc +++ b/modules/administration-guide/pages/understanding-the-checluster-custom-resource.adoc @@ -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. diff --git a/modules/administration-guide/partials/snip_mounting-a-secret-or-a-configmap-into-a-container.adoc b/modules/administration-guide/partials/snip_mounting-a-secret-or-a-configmap-into-a-container.adoc index c386cb95a0..e326fa844e 100644 --- a/modules/administration-guide/partials/snip_mounting-a-secret-or-a-configmap-into-a-container.adoc +++ b/modules/administration-guide/partials/snip_mounting-a-secret-or-a-configmap-into-a-container.adoc @@ -13,7 +13,6 @@ + * The `` corresponds to the one following deployments: -** `postgres` ** `keycloak` ** `devfile-registry` ** `plugin-registry` diff --git a/tools/checluster_docs_gen.sh b/tools/checluster_docs_gen.sh index 6ebeb32253..70871c2135 100755 --- a/tools/checluster_docs_gen.sh +++ b/tools/checluster_docs_gen.sh @@ -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." diff --git a/tools/create_architecture_diagrams.py b/tools/create_architecture_diagrams.py index f9d1a4a0b9..502bed6305 100755 --- a/tools/create_architecture_diagrams.py +++ b/tools/create_architecture_diagrams.py @@ -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,