Details about the different options to integrate StackGres with some service mesh implementations.
Chapter 1 Introduction Discover what StackGres is all about and the core concepts behind it. What is StackGres? Details about what StackGres is. Concepts Details about StackGres' concepts. Architecture Details about StackGres' architecture. Licensing Details about StackGres' license. Versions Details about StackGres versions. Tested Environments StackGres was tested and validated in the following environments: Cloud Provider Kubernetes versions AWS EKS 1.
Chapter 2 Features Details about StackGres' features: Declarative CRs Manage your PostgreSQL cluster using declarative StackGres CRs Tuned by Default Expertly-tuned PostgreSQL by default Custom Configuration Provide custom configuration on top of vanilla PostgreSQL High Availability High availability and automated failover Automated Backups Automated backups and backup lifecycle management Server-Side Connection Pooling Integrated server-side connection pooling Distributed Logs Distributed logs for Postgres and Patroni
Chapter 3 Getting Started On this page, you will learn how to get started with StackGres. We will install StackGres on a Kubernetes cluster and create a Postgres instance. NOTE: To run this demo you need a K8s environment with kubectl command already configured to use it. You will also need helm command version >= 3.16. Set Up the Helm Repository Add the StackGres Helm repository: helm repo add stackgres-charts https://stackgres.
Chapter 5 Administration Manual Administration of postgres clusters created with StackGres. Installation Documentation how to install the StackGres operator. Connecting to the Cluster This page contains details about how to connect to a StackGres cluster. Creating a Cluster Details about how to create a production StackGres cluster. Configuration Details about default and custom configurations. Backups Details about how to set up and configure backups.
Chapter 6 CRD Reference This is the reference for the StackGres-provided custom resource definitions (CRDs). SGCluster Details about SGCluster SGInstanceProfile Details about SGInstanceProfile SGPostgresConfig Details about SGPostgresConfig SGPoolingConfig Details about SGPoolingConfig SGBackup Details about SGBackup SGShardedBackup Details about SGShardedBackup SGDistributedLogs Details about SGDistributedLogs
Chapter 7 Developer Documentation StackGres is 100% open source. You can build it yourself to try the latest functionalities and enhance it to add custom behavior. Pre-Requisites Details about the necessary tools to build and use StackGres. Building StackGres Details about how to build the operator. Building StackGres operator images Details about how to build the container images. Running StackGres Outside of K8s Details about how to run the operator outside of Kubernetes.
Chapter 8 Operator API The StackGres operator offers a REST API to manipulate StackGres resources via HTTP. Error Responses Details about the Error Codes, PostgreSQL Blocklist settings, and forbidden actions. RBAC Authorization Overview Details about how to set up RBAC autorization. StackGres REST API Reference Details about StackGres' REST API and its endpoints.
Chapter 9 Runbooks This chapter contains runbooks how to perform specific day-two operations. PgBadger Reports Details about how to generate a pgBadger report from the distributed logs server. Volume Downsize Steps about how to perform a volume downsize Restoring a Backup Details about how to restore a StackGres cluster backup. Postgres Alerts How to add Postgres alerts to your Prometheus installation
Operator Availability Concerns Operator availability only affect the operational plane. The data plane is not affected at all and the databases will work as expected even when the operator is offline. The operator is kept available in a best-effort manner. If at some point the operator becomes unavailable, this can lead to unavailability of following operational aspects: Cluster creation / update Cluster configuration creation / update / deletion Backups generation Reconciliation of modified resources controlled by the operator (when modified by the user or some other means) The availability of the operator does not affect the following functional aspects:
Details about how to work in a K8s cluster with Istio