-
Notifications
You must be signed in to change notification settings - Fork 39
Expand file tree
/
Copy pathindex.html
More file actions
390 lines (367 loc) · 18.1 KB
/
index.html
File metadata and controls
390 lines (367 loc) · 18.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="description" content="None" /><meta name="author" content="The CloudNativePG Contributors" />
<link rel="shortcut icon" href="img/favicon.ico" />
<title>CloudNativePG</title>
<link rel="stylesheet" href="css/theme.css" />
<link rel="stylesheet" href="css/theme_extra.css" />
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.3/styles/github.min.css" />
<script>
// Current page data
var mkdocs_page_name = "CloudNativePG";
var mkdocs_page_input_path = "index.md";
var mkdocs_page_url = null;
</script>
<script src="js/jquery-3.6.0.min.js" defer></script>
<!--[if lt IE 9]>
<script src="js/html5shiv.min.js"></script>
<![endif]-->
<script src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.7.3/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
</head>
<body class="wy-body-for-nav" role="document">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="." class="icon icon-home"> CloudNativePG
</a><div role="search">
<form id ="rtd-search-form" class="wy-form" action="./search.html" method="get">
<input type="text" name="q" placeholder="Search docs" title="Type search term here" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal current" href=".">CloudNativePG</a>
<ul class="current">
<li class="toctree-l2"><a class="reference internal" href="#supported-kubernetes-distributions">Supported Kubernetes distributions</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#container-images">Container images</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#main-features">Main features</a>
</li>
<li class="toctree-l2"><a class="reference internal" href="#about-this-guide">About this guide</a>
</li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="before_you_start/">Before You Start</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="use_cases/">Use cases</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="architecture/">Architecture</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation_upgrade/">Installation and upgrades</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="quickstart/">Quickstart</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="bootstrap/">Bootstrap</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="security/">Security</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="instance_manager/">Postgres instance manager</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="scheduling/">Scheduling</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="resource_management/">Resource management</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="failure_modes/">Failure Modes</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="rolling_update/">Rolling Updates</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="replication/">Replication</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="backup_recovery/">Backup and Recovery</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="postgresql_conf/">PostgreSQL Configuration</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="operator_conf/">Operator configuration</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="storage/">Storage</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="labels_annotations/">Labels and annotations</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="monitoring/">Monitoring</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="logging/">Logging</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="certificates/">Certificates</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="ssl_connections/">Client TLS/SSL Connections</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="applications/">Connecting from an application</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="connection_pooling/">Connection Pooling</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="replica_cluster/">Replica clusters</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="kubernetes_upgrade/">Kubernetes Upgrade</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="expose_pg_services/">Exposing Postgres Services</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="cnpg-plugin/">CloudNativePG Plugin</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="failover/">Automated failover</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="troubleshooting/">Troubleshooting</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="fencing/">Fencing</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="postgis/">PostGIS</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="e2e/">End-to-End Tests</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="container_images/">Container Image Requirements</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="operator_capability_levels/">Operator Capability Levels</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="samples/">Examples</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="commercial_support/">Commercial support</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="faq/">Frequently Asked Questions (FAQ)</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="api_reference/">API Reference</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="supported_releases/">Supported releases</a>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="release_notes/">Release notes</a>
</li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" role="navigation" aria-label="Mobile navigation menu">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href=".">CloudNativePG</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content"><div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="." class="icon icon-home" alt="Docs"></a> »</li><li>CloudNativePG</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div class="section" itemprop="articleBody">
<h1 id="cloudnativepg">CloudNativePG</h1>
<p><strong>CloudNativePG</strong> is an open source
<a href="https://kubernetes.io/docs/concepts/extend-kubernetes/operator/">operator</a>
designed to manage <a href="https://www.postgresql.org/">PostgreSQL</a> workloads on any
supported <a href="https://kubernetes.io">Kubernetes</a> cluster running in private,
public, hybrid, or multi-cloud environments.
CloudNativePG adheres to DevOps principles and concepts such as declarative
configuration and immutable infrastructure.</p>
<p>It defines a new Kubernetes resource called <code>Cluster</code> representing a PostgreSQL
cluster made up of a single primary and an optional number of replicas that co-exist
in a chosen Kubernetes namespace for High Availability and offloading of
read-only queries.</p>
<p>Applications that reside in the same Kubernetes cluster can access the
PostgreSQL database using a service which is solely managed by the operator,
without having to worry about changes of the primary role following a failover
or a switchover. Applications that reside outside the Kubernetes cluster, need
to configure a Service or Ingress object to expose the Postgres via TCP.
Web applications can take advantage of the native connection pooler based on PgBouncer.</p>
<p>CloudNativePG was originally built by <a href="https://www.enterprisedb.com">EDB</a>, then
released open source under Apache License 2.0 and submitted for CNCF Sandbox in April 2022.
The <a href="https://github.com/cloudnative-pg/cloudnative-pg">source code repository is in Github</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Based on the <a href="operator_capability_levels/">Operator Capability Levels model</a>,
users can expect a <strong>"Level V - Auto Pilot"</strong> set of capabilities from the
CloudNativePG Operator.</p>
</div>
<h2 id="supported-kubernetes-distributions">Supported Kubernetes distributions</h2>
<p>CloudNativePG 1.15 requires Kubernetes 1.21 through 1.23.
For more information, please refer to the
<a href="supported_releases/">"Supported releases"</a> page.</p>
<h2 id="container-images">Container images</h2>
<p>The <a href="https://github.com/cloudnative-pg">CloudNativePG community</a> maintains
container images for both the operator and the operand, that is PostgreSQL.</p>
<p>The CloudNativePG operator container images are <a href="https://github.com/GoogleContainerTools/distroless">distroless</a>
and available on the <a href="https://github.com/cloudnative-pg/cloudnative-pg/pkgs/container/cloudnative-pg"><code>cloudnative-pg</code> project's GitHub Container Registry</a>.</p>
<p>The PostgreSQL operand container images are available for all the
<a href="https://www.postgresql.org/">PGDG supported versions of PostgreSQL</a>,
on multiple architectures, directly from the
<a href="https://github.com/cloudnative-pg/postgres-containers/pkgs/container/postgresql"><code>postgres-containers</code> project's GitHub Container Registry</a>.</p>
<p>Additionally, the Community provides images for the <a href="postgis/">PostGIS extension</a>.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>CloudNativePG requires that all nodes in a Kubernetes cluster have the
same CPU architecture, thus a hybrid CPU architecture Kubernetes cluster is not
supported.</p>
</div>
<h2 id="main-features">Main features</h2>
<ul>
<li>Direct integration with Kubernetes API server for High Availability,
without requiring an external tool</li>
<li>Self-Healing capability, through:<ul>
<li>failover of the primary instance by promoting the most aligned replica</li>
<li>automated recreation of a replica</li>
</ul>
</li>
<li>Planned switchover of the primary instance by promoting a selected replica</li>
<li>Scale up/down capabilities</li>
<li>Definition of an arbitrary number of instances (minimum 1 - one primary server)</li>
<li>Definition of the <em>read-write</em> service, to connect your applications to the only primary server of the cluster</li>
<li>Definition of the <em>read-only</em> service, to connect your applications to any of the instances for reading workloads</li>
<li>Declarative management of PostgreSQL configuration, including certain popular
Postgres extensions through the cluster <code>spec</code>: <code>pg_audit</code>, <code>auto_explain</code>,
and <code>pg_stat_statements</code></li>
<li>Support for Local Persistent Volumes with PVC templates</li>
<li>Reuse of Persistent Volumes storage in Pods</li>
<li>Rolling updates for PostgreSQL minor versions</li>
<li>In-place or rolling updates for operator upgrades</li>
<li>TLS connections and client certificate authentication</li>
<li>Support for custom TLS certificates (including integration with cert-manager)</li>
<li>Continuous backup to an object store (AWS S3 and S3-compatible, Azure Blob Storage, and Google Cloud Storage)</li>
<li>Backup retention policies (based on recovery window)</li>
<li>Full recovery and Point-In-Time recovery from an existing backup in an object store</li>
<li>Parallel WAL archiving and restore to allow the database to keep up with WAL
generation on high write systems</li>
<li>Support tagging backup files uploaded to an object store to enable optional
retention management at the object store layer Replica clusters for</li>
<li>PostgreSQL deployments across multiple Kubernetes
clusters, enabling private, public, hybrid, and multi-cloud architectures</li>
<li>Support for Synchronous Replicas</li>
<li>Connection pooling with PgBouncer</li>
<li>Support for node affinity via <code>nodeSelector</code></li>
<li>Native customizable exporter of user defined metrics for Prometheus through the <code>metrics</code> port (9187)</li>
<li>Standard output logging of PostgreSQL error messages in JSON format</li>
<li>Automatically set <code>readOnlyRootFilesystem</code> security context for pods</li>
<li><code>cnpg</code> plugin for <code>kubectl</code></li>
<li>Fencing of an entire PostgreSQL cluster, or a subset of the instances</li>
<li>Simple bind and search+bind LDAP client authentication</li>
<li>Multi-arch format container images</li>
</ul>
<h2 id="about-this-guide">About this guide</h2>
<p>Follow the instructions in the <a href="quickstart/">"Quickstart"</a> to test CloudNativePG
on a local Kubernetes cluster using Kind, or Minikube.</p>
<p>In case you are not familiar with some basic terminology on Kubernetes and PostgreSQL,
please consult the <a href="before_you_start/">"Before you start" section</a>.</p>
<p><em><a href="https://www.postgresql.org/about/policies/trademarks/">Postgres, PostgreSQL and the Slonik Logo</a>
are trademarks or registered trademarks of the PostgreSQL Community Association
of Canada, and used with their permission.</em></p>
</div>
</div><footer>
<div class="rst-footer-buttons" role="navigation" aria-label="Footer Navigation">
<a href="before_you_start/" class="btn btn-neutral float-right" title="Before You Start">Next <span class="icon icon-circle-arrow-right"></span></a>
</div>
<hr/>
<div role="contentinfo">
<!-- Copyright etc -->
</div>
Built with <a href="https://www.mkdocs.org/">MkDocs</a> using a <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<div class="rst-versions" role="note" aria-label="Versions">
<span class="rst-current-version" data-toggle="rst-current-version">
<span><a href="before_you_start/" style="color: #fcfcfc">Next »</a></span>
</span>
</div>
<script>var base_url = '.';</script>
<script src="js/theme_extra.js" defer></script>
<script src="js/theme.js" defer></script>
<script src="search/main.js" defer></script>
<script defer>
window.onload = function () {
SphinxRtdTheme.Navigation.enable(true);
};
</script>
</body>
</html>
<!--
MkDocs version : 1.3.0
Build Date UTC : 2022-10-06 22:02:13.163327+00:00
-->