-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #5540 from EnterpriseDB/automatic_docs_update/repo…
…_EnterpriseDB/cloud-native-postgres/ref_refs/tags/v1.23.0
- Loading branch information
Showing
38 changed files
with
1,140 additions
and
774 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
110 changes: 110 additions & 0 deletions
110
product_docs/docs/postgres_for_kubernetes/1/image_catalog.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,110 @@ | ||
--- | ||
title: 'Image Catalog' | ||
originalFilePath: 'src/image_catalog.md' | ||
--- | ||
|
||
`ImageCatalog` and `ClusterImageCatalog` are essential resources that empower | ||
you to define images for creating a `Cluster`. | ||
|
||
The key distinction lies in their scope: an `ImageCatalog` is namespaced, while | ||
a `ClusterImageCatalog` is cluster-scoped. | ||
|
||
Both share a common structure, comprising a list of images, each equipped with | ||
a `major` field indicating the major version of the image. | ||
|
||
!!! Warning | ||
The operator places trust in the user-defined major version and refrains | ||
from conducting any PostgreSQL version detection. It is the user's | ||
responsibility to ensure alignment between the declared major version in | ||
the catalog and the PostgreSQL image. | ||
|
||
The `major` field's value must remain unique within a catalog, preventing | ||
duplication across images. Distinct catalogs, however, may | ||
expose different images under the same `major` value. | ||
|
||
**Example of a Namespaced `ImageCatalog`:** | ||
|
||
```yaml | ||
apiVersion: postgresql.k8s.enterprisedb.io/v1 | ||
kind: ImageCatalog | ||
metadata: | ||
name: postgresql | ||
namespace: default | ||
spec: | ||
images: | ||
- major: 15 | ||
image: quay.io/enterprisedb/postgresql:15.6 | ||
- major: 16 | ||
image: quay.io/enterprisedb/postgresql:16.2 | ||
``` | ||
**Example of a Cluster-Wide Catalog using `ClusterImageCatalog` Resource:** | ||
|
||
```yaml | ||
apiVersion: postgresql.k8s.enterprisedb.io/v1 | ||
kind: ClusterImageCatalog | ||
metadata: | ||
name: postgresql | ||
spec: | ||
images: | ||
- major: 15 | ||
image: quay.io/enterprisedb/postgresql:15.6 | ||
- major: 16 | ||
image: quay.io/enterprisedb/postgresql:16.2 | ||
``` | ||
|
||
A `Cluster` resource has the flexibility to reference either an `ImageCatalog` | ||
or a `ClusterImageCatalog` to precisely specify the desired image. | ||
|
||
```yaml | ||
apiVersion: postgresql.k8s.enterprisedb.io/v1 | ||
kind: Cluster | ||
metadata: | ||
name: cluster-example | ||
spec: | ||
instances: 3 | ||
imageCatalogRef: | ||
apiGroup: postgresql.k8s.enterprisedb.io | ||
kind: ImageCatalog | ||
name: postgresql | ||
major: 16 | ||
storage: | ||
size: 1Gi | ||
``` | ||
|
||
Clusters utilizing these catalogs maintain continuous monitoring. | ||
Any alterations to the images within a catalog trigger automatic updates for | ||
**all associated clusters** referencing that specific entry. | ||
|
||
## EDB Postgres for Kubernetes Catalogs | ||
|
||
The EDB Postgres for Kubernetes project maintains `ClusterImageCatalogs` for the images it | ||
provides. These catalogs are regularly updated with the latest images for each | ||
major version. By applying the `ClusterImageCatalog.yaml` file from the | ||
EDB Postgres for Kubernetes project's GitHub repositories, cluster administrators can ensure | ||
that their clusters are automatically updated to the latest version within the | ||
specified major release. | ||
|
||
### PostgreSQL Container Images | ||
|
||
You can install the | ||
[latest version of the cluster catalog for the PostgreSQL Container Images](https://raw.githubusercontent.com/cloudnative-pg/postgres-containers/main/Debian/ClusterImageCatalog.yaml) | ||
([cloudnative-pg/postgres-containers](https://github.com/enterprisedb/docker-postgres) repository) | ||
with: | ||
|
||
```shell | ||
kubectl apply \ | ||
-f https://raw.githubusercontent.com/cloudnative-pg/postgres-containers/main/Debian/ClusterImageCatalog.yaml | ||
``` | ||
|
||
### PostGIS Container Images | ||
|
||
You can install the | ||
[latest version of the cluster catalog for the PostGIS Container Images](https://raw.githubusercontent.com/cloudnative-pg/postgis-containers/main/PostGIS/ClusterImageCatalog.yaml) | ||
([cloudnative-pg/postgis-containers](https://github.com/cloudnative-pg/postgis-containers) repository) | ||
with: | ||
|
||
```shell | ||
kubectl apply \ | ||
-f https://raw.githubusercontent.com/cloudnative-pg/postgis-containers/main/PostGIS/ClusterImageCatalog.yaml | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
5945f21
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Published on https://edb-docs-staging.netlify.app as production
🚀 Deployed on https://662ac87592dc90192fd72025--edb-docs-staging.netlify.app