-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
742 lines (680 loc) · 33.5 KB
/
mkdocs.yml
File metadata and controls
742 lines (680 loc) · 33.5 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
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
site_name: pgEdge Documentation
site_url: https://docs.pgedge.com
extra_css:
- stylesheets/extra.css
- stylesheets/chat.css
- stylesheets/package-catalog.css
# Highlight.js for dynamic code highlighting in chat
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/github.min.css
extra_javascript:
# Pulled from control-plane repo for install page
# Note: Must update version when control-plane latest version changes
- /control-plane/v0-7/scripts/generate-stack.js
- javascripts/tabs-dropdown.js
- javascripts/org-stars.js
- javascripts/version-selector.js
- javascripts/pagefind-search.js
# Highlight.js for dynamic code highlighting in chat (must load before chat.js)
- https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js
- javascripts/chat.js
- enterprise/js/package-catalog.js
hooks:
- hooks/versioned_redirects.py
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
plugins:
- search:
enabled: false
- multirepo:
cleanup: true
keep_docs_dir: false
- redoc-tag
- gh-admonitions
- redirects:
redirect_maps:
# Legacy pgedge-containers versioned URLs redirect to pgedge-helm
pgedge-containers/v0-1/index.md: pgedge-helm/v0-1/index.md
pgedge-containers/development/index.md: pgedge-helm/development/index.md
# Redirect old pgedge-containers URLs to new pgedge-container URLs
pgedge-containers/index.md: pgedge-container/index.md
pgedge-containers/helm.md: pgedge-container/helm.md
# Legacy /platform/ paths that moved or were restructured
platform/advanced/snowflake.md: snowflake/index.md
platform/advanced/ace.md: platform/ace/index.md
platform/advanced/autoddl.md: platform/managing/autoddl.md
platform/advanced/exception.md: platform/managing/exception.md
platform/autoddl.md: platform/managing/autoddl.md
platform/exception.md: platform/managing/exception.md
platform/lolor.md: lolor/index.md
platform/snowflake.md: snowflake/index.md
platform/managing.md: platform/managing/guc_values.md
platform/modify.md: platform/modify/spock_sync.md
platform/monitoring.md: platform/monitoring/find_info.md
platform/troubleshooting/troubleshooting.md: platform/troubleshooting.md
platform/troubleshooting/logging.md: platform/troubleshooting.md
# Legacy /cloud/ paths that moved
cloud/cl_release_notes.md: cloud/index.md
cloud/getting_started.md: cloud/getting_started/getting_started.md
cloud/getting_started/de_getting_started.md: cloud/getting_started/getting_started.md
cloud/database_admin.md: cloud/database/index.md
cloud/database_admin/integrations.md: cloud/database/index.md
cloud/database_admin/table_mgmt.md: cloud/database/index.md
cloud/mod_cluster.md: cloud/mod_cluster/actions.md
cloud/prerequisites.md: cloud/prerequisites/ssh_key.md
cloud/backup/backup_store.md: cloud/cluster/backup_store.md
cloud/connecting/https.md: cloud/connecting/index.md
# Versioned documentation root redirects
# Each product root redirects to the latest version
# (The actual redirect is handled by docs/<product>/index.md files)
theme:
name: material
custom_dir: overrides
favicon: img/favicon.ico
logo_dark_mode: 'img/logo-dark.png'
logo_light_mode: 'img/logo-light.png'
features:
- navigation.tabs
# - navigation.instant # Disabled - causes logo flash on redirect pages
- navigation.tracking
- navigation.prune
- navigation.top
- toc.follow
- content.code.copy
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: cyan
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: cyan
toggle:
icon: material/brightness-4
name: Switch to system preference
extra:
discord_url: https://discord.com/invite/pgedge/login
generator: false
analytics:
provider: google
property: G-13N8VBYE5D
consent:
title: Cookie consent
description: >-
We use cookies to recognize your repeated visits and preferences, as well
as to measure the effectiveness of our documentation and whether users
find what they're searching for. With your consent, you're helping us to
make our documentation better.
cookies:
analytics:
name: Google Analytics
checked: true
github:
name: GitHub
checked: true
actions:
- accept
- reject
- manage
# Versioned documentation - list docsets that have multiple versions
# Versions are auto-detected from nav structure
# Convention: first version = latest, "Development" = unstable/main branch
versioned_docsets:
- pgedge-helm
- ace
- ai-dba-workbench
- lolor
- snowflake
- spock-v5
- control-plane
- pgedge-postgres-mcp-server
- pgedge-anonymizer
- pgedge-docloader
- pgedge-loadgen
- pgedge-rag-server
- pgedge-vectorizer
- pg-semantic-cache
- pgedge-safesession
- pgedge-mcp-bridge
- radar
- postgresql
- pg-cron
- pg-stat-monitor
- pg-tokenizer
- pg-vectorize
- pgadmin-4
- pgaudit
- pgbackrest
- pgbouncer
- pgmq
- pgvector
- pldebugger
- postgis
- postgrest
- psycopg2
- system-stats
- vchord-bm25
- cloudnativepg
- patroni
# pgEdge Labs - shows a notice that content is experimental/under active development
labs_docsets:
- pg-semantic-cache
- pgedge-safesession
- pgedge-mcp-bridge
# Third-party documentation - shows a notice that content is not maintained by pgEdge
third_party_docsets:
- postgresql
- pg-cron
- pg-stat-monitor
- pg-tokenizer
- pg-vectorize
- pgadmin-4
- pgaudit
- pgbackrest
- pgbouncer
- pgmq
- pgvector
- pldebugger
- postgis
- postgrest
- psycopg2
- system-stats
- vchord-bm25
- cloudnativepg
- patroni
# Navigation dropdown categories
# Supported item types:
# - title/url: clickable link
# - heading: non-clickable sub-heading label
# - hr: horizontal rule divider
nav_categories:
Deployment:
- heading: "VM / Bare Metal"
- title: Control Plane
url: control-plane/
- title: Enterprise Repository
url: enterprise/
- title: Ansible
url: ansible/
- hr: true
- title: Containers
url: pgedge-container/
- hr: true
- title: pgEdge Cloud
url: cloud/
AI Toolkit:
- title: Overview
url: ai-toolkit/
- hr: true
- heading: "pgEdge Components"
- title: AI DBA Workbench
url: ai-dba-workbench/
- title: pgEdge Postgres MCP Server
url: pgedge-postgres-mcp-server/
- title: pgEdge RAG Server
url: pgedge-rag-server/
- title: pgEdge Docloader
url: pgedge-docloader/
- title: pgEdge Vectorizer
url: pgedge-vectorizer/
- hr: true
- heading: "Community Components"
- title: pg_tokenizer
url: pg-tokenizer/
- title: pg_vectorize
url: pg-vectorize/
- title: pgVector
url: pgvector/
- title: vchord_bm25
url: vchord-bm25/
Database:
- title: PostgreSQL
url: postgresql/
- hr: true
- heading: "pgEdge Extensions"
- title: Spock v5
url: spock-v5/
- title: LOLOR
url: lolor/
- title: Snowflake
url: snowflake/
- title: pgEdge Vectorizer
url: pgedge-vectorizer/
- hr: true
- heading: "Community Extensions"
- title: pg_cron
url: pg-cron/
- title: pg_stat_monitor
url: pg-stat-monitor/
- title: pgAudit
url: pgaudit/
- title: pgmq
url: pgmq/
- title: pgVector
url: pgvector/
- title: pldebugger
url: pldebugger/
- title: PostGIS
url: postgis/
- title: system_stats
url: system-stats/
Tools:
- heading: "pgEdge Tools"
- title: AI DBA Workbench
url: ai-dba-workbench/
- title: ACE
url: ace/
- title: pgEdge Anonymizer
url: pgedge-anonymizer/
- title: pgEdge Loadgen
url: pgedge-loadgen/
- title: Radar
url: radar/
- hr: true
- heading: "Community Tools"
- title: CloudNativePG
url: cloudnativepg/
- title: Patroni
url: patroni/
- title: pgAdmin 4
url: pgadmin-4/
- title: pgBackRest
url: pgbackrest/
- title: PgBouncer
url: pgbouncer/
- title: PostgREST
url: postgrest/
- title: psycopg2
url: psycopg2/
pgEdge Labs:
- title: Semantic Cache (pg_semantic_cache)
url: pg-semantic-cache/
- title: Safe Session (pgedge-safesession)
url: pgedge-safesession/
- title: MCP Bridge (pgedge-mcp-bridge)
url: pgedge-mcp-bridge/
copyright: Copyright © 2023 - 2026, pgEdge, Inc. Third-party documentation is copyright of its respective authors –
<a href="#__consent">Change cookie settings</a>
repo_url: https://github.com/pgEdge
nav:
- Welcome: index.md
- AI Toolkit: ai-toolkit/index.md
- Ansible: '!import https://github.com/pgEdge/pgedge-ansible.git?branch=add_docs'
- pgEdge Enterprise Postgres:
- Enterprise Edition: enterprise/index.md
- Enterprise Linux 9 & 10:
- Enterprise Linux Version Support: enterprise/el/index.md
- Getting Started - Configuring the Repository: enterprise/el/configure-repo.md
- Installing Postgres: enterprise/el/installing.md
- Supporting Components:
- Installing Supporting Components: enterprise/el/components/components.md
- Configuring Patroni: enterprise/el/components/patroni.md
- Configuring PgBouncer: enterprise/el/components/pgbouncer.md
- Migrating to pgEdge Enterprise Postgres: enterprise/el/migrating.md
- Upgrading Spock: enterprise/el/upgrading-spock.md
- Creating an Offline Repo: enterprise/el/offline.md
- Debian 11, 12, and 13 & Ubuntu 22.04 LTS and 24.04 LTS:
- Debian & Ubuntu Version Support: enterprise/debian/index.md
- Getting Started - Configuring the Repository: enterprise/debian/configure-repo.md
- Installing Postgres: enterprise/debian/installing.md
- Supporting Components:
- Installing Supporting Components: enterprise/debian/components/components.md
- Configuring Patroni: enterprise/debian/components/patroni.md
- Configuring PgBouncer: enterprise/debian/components/pgbouncer.md
- Migrating to pgEdge Enterprise Postgres: enterprise/debian/migrating.md
- Upgrading Spock: enterprise/debian/upgrading-spock.md
- Creating an Offline Repo: enterprise/debian/offline.md
- Troubleshooting: enterprise/troubleshooting.md
- Enterprise Postgres Release Notes: enterprise/pep_rel_notes.md
- pgEdge Distributed Postgres:
- CLI Overview: platform/index.md
- Prerequisites - Preparing your System:
- Supported Operating Systems: platform/prerequisites/platforms.md
- Preparing your System for the CLI: platform/prerequisites/index.md
- pgEdge Architecture Models: platform/prerequisites/architecture.md
- Planning for Active-Active Replication: platform/prerequisites/configuring.md
- Installing pgEdge Distributed Postgres VM Edition:
- Overview: platform/installing_pgedge/index.md
- Tutorial - Manually Deploying a Cluster: platform/installing_pgedge/manual.md
- Tutorial - Deploying a Cluster with a Configuration Files: platform/installing_pgedge/cluster_deploy.md
- Creating, Managing, and Deploying with a Configuration Files: platform/installing_pgedge/json.md
- Upgrading your CLI Installation: platform/installing_pgedge/upgrade_cli.md
- Upgrading your Spock Installation: platform/installing_pgedge/upgrade_spock.md
- Creating an Offline Repository for pgEdge Distributed Postgres: platform/installing_pgedge/offline_repo.md
- Adding or Removing Cluster Nodes:
- Using Spock to Synchronize a New Node: platform/modify/spock_sync.md
- Adding a Node to your Cluster with the CLI: platform/modify/add_node.md
- Removing a Node from your Cluster: platform/modify/remove_node.md
- Managing a Cluster:
- Setting Parameter Values: platform/managing/guc_values.md
- Using Automatic DDL Replication: platform/managing/autoddl.md
- Managing Replication Exceptions: platform/managing/exception.md
- Managing Supported Extensions: platform/managing/supported_extensions.md
- Configuring Backups with pgBackRest: platform/managing/pgbackrest.md
- Creating Custom Filters: platform/managing/filtering.md
- Monitoring Cluster Information: platform/monitoring/find_info.md
- ACE (the Active Consistency Engine):
- Managing Data Consistency with ACE: platform/ace/index.md
- Installing ACE: platform/ace/installing_ace.md
- Enhancing ACE Performance with Merkle Trees: platform/ace/merkle.md
- Using ACE Functions: platform/ace/ace_functions.md
- ACE API Endpoints: platform/ace/ace_api.md
- Scheduling ACE Operations and Repairs: platform/ace/schedule_ace.md
- CLI Reference:
- Using the CLI: platform/pgedge_commands/index.md
- ace Commands:
- ACE commands: platform/pgedge_commands/ace/index.md
- ace-mtree: platform/pgedge_commands/doc/ace-mtree.md
- ace-repset-diff: platform/pgedge_commands/doc/ace-repset-diff.md
- ace-schema-diff: platform/pgedge_commands/doc/ace-schema-diff.md
- ace-spock-diff: platform/pgedge_commands/doc/ace-spock-diff.md
- ace-spock-exception-update: platform/pgedge_commands/doc/ace-spock-exception-update.md
- ace-start: platform/pgedge_commands/doc/ace-start.md
- ace-table-diff: platform/pgedge_commands/doc/ace-table-diff.md
- ace-table-repair: platform/pgedge_commands/doc/ace-table-repair.md
- ace-table-rerun: platform/pgedge_commands/doc/ace-table-rerun.md
- db Commands:
- db Commands: platform/pgedge_commands/db/index.md
- db-create: platform/pgedge_commands/doc/db-create.md
- db-guc-set: platform/pgedge_commands/doc/db-guc-set.md
- db-guc-show: platform/pgedge_commands/doc/db-guc-show.md
- db-set-readonly: platform/pgedge_commands/doc/db-set-readonly.md
- db-test-io: platform/pgedge_commands/doc/db-test-io.md
- cluster Commands:
- cluster Commands: platform/pgedge_commands/cluster/index.md
- cluster-add-db: platform/pgedge_commands/doc/cluster-add-db.md
- cluster-add-node: platform/pgedge_commands/doc/cluster-add-node.md
- cluster-app-concurrent-index: platform/pgedge_commands/doc/cluster-app-concurrent-index.md
- cluster-app-install: platform/pgedge_commands/doc/cluster-app-install.md
- cluster-app-remove: platform/pgedge_commands/doc/cluster-app-remove.md
- cluster-command: platform/pgedge_commands/doc/cluster-command.md
- cluster-init: platform/pgedge_commands/doc/cluster-init.md
- cluster-json-create: platform/pgedge_commands/doc/cluster-json-create.md
- cluster-json-template: platform/pgedge_commands/doc/cluster-json-template.md
- cluster-json-validate: platform/pgedge_commands/doc/cluster-json-validate.md
- cluster-list-nodes: platform/pgedge_commands/doc/cluster-list-nodes.md
- cluster-remove-node: platform/pgedge_commands/doc/cluster-remove-node.md
- cluster-remove: platform/pgedge_commands/doc/cluster-remove.md
- cluster-replication-begin: platform/pgedge_commands/doc/cluster-replication-begin.md
- cluster-replication-check: platform/pgedge_commands/doc/cluster-replication-check.md
- cluster-ssh: platform/pgedge_commands/doc/cluster-ssh.md
- localhost Commands:
- localhost Commands: platform/pgedge_commands/localhost/index.md
- localhost-cluster-create: platform/pgedge_commands/doc/localhost-cluster-create.md
- localhost-cluster-deploy: platform/pgedge_commands/doc/localhost-cluster-destroy.md
- service Commands:
- service Commands: platform/pgedge_commands/service/index.md
- service-config: platform/pgedge_commands/doc/service-config.md
- service-disable: platform/pgedge_commands/doc/service-disable.md
- service-enable: platform/pgedge_commands/doc/service-enable.md
- service-init: platform/pgedge_commands/doc/service-init.md
- service-reload: platform/pgedge_commands/doc/service-reload.md
- service-restart: platform/pgedge_commands/doc/service-restart.md
- service-start: platform/pgedge_commands/doc/service-start.md
- service-status: platform/pgedge_commands/doc/service-status.md
- service-stop: platform/pgedge_commands/doc/service-stop.md
- The setup Command:
- The setup Command: platform/pgedge_commands/setup/index.md
- setup: platform/pgedge_commands/doc/setup.md
- spock Commands:
- spock Commands: platform/pgedge_commands/spock/index.md
- spock-health-check: platform/pgedge_commands/doc/spock-health-check.md
- spock-metrics-check: platform/pgedge_commands/doc/spock-metrics-check.md
- spock-node-add-interface: platform/pgedge_commands/doc/spock-node-add-interface.md
- spock-node-alter-location: platform/pgedge_commands/doc/spock-node-alter-location.md
- spock-node-create: platform/pgedge_commands/doc/spock-node-create.md
- spock-node-drop-interface: platform/pgedge_commands/doc/spock-node-drop-interface.md
- spock-node-drop: platform/pgedge_commands/doc/spock-node-drop.md
- spock-node-list: platform/pgedge_commands/doc/spock-node-list.md
- spock-replicate-ddl: platform/pgedge_commands/doc/spock-replicate-ddl.md
- spock-repset-add-partition: platform/pgedge_commands/doc/spock-repset-add-partition.md
- spock-repset-add-table: platform/pgedge_commands/doc/spock-repset-add-table.md
- spock-repset-alter: platform/pgedge_commands/doc/spock-repset-alter.md
- spock-repset-create: platform/pgedge_commands/doc/spock-repset-create.md
- spock-repset-drop: platform/pgedge_commands/doc/spock-repset-drop.md
- spock-repset-list-tables: platform/pgedge_commands/doc/spock-repset-list-tables.md
- spock-repset-remove-partition: platform/pgedge_commands/doc/spock-repset-remove-partition.md
- spock-repset-remove-table: platform/pgedge_commands/doc/spock-repset-remove-table.md
- spock-sequence-convert: platform/pgedge_commands/doc/spock-sequence-convert.md
- spock-set-readonly: platform/pgedge_commands/doc/spock-set-readonly.md
- spock-sub-add-repset: platform/pgedge_commands/doc/spock-sub-add-repset.md
- spock-sub-alter-interface: platform/pgedge_commands/doc/spock-sub-alter-interface.md
- spock-sub-create: platform/pgedge_commands/doc/spock-sub-create.md
- spock-sub-disable: platform/pgedge_commands/doc/spock-sub-disable.md
- spock-sub-drop: platform/pgedge_commands/doc/spock-sub-drop.md
- spock-sub-enable: platform/pgedge_commands/doc/spock-sub-enable.md
- spock-sub-remove-repset: platform/pgedge_commands/doc/spock-sub-remove-repset.md
- spock-sub-resync-table: platform/pgedge_commands/doc/spock-sub-resync-table.md
- spock-sub-show-status: platform/pgedge_commands/doc/spock-sub-show-status.md
- spock-sub-show-table: platform/pgedge_commands/doc/spock-sub-show-table.md
- spock-sub-wait-for-sync: platform/pgedge_commands/doc/spock-sub-wait-for-sync.md
- spock-table-wait-for-sync: platform/pgedge_commands/doc/spock-table-wait-for-sync.md
- update manager Commands:
- um Commands: platform/pgedge_commands/um/index.md
- um-clean.md: platform/pgedge_commands/doc/um-clean.md
- um-download.md: platform/pgedge_commands/doc/um-download.md
- um-install.md: platform/pgedge_commands/doc/um-install.md
- um-list.md: platform/pgedge_commands/doc/um-list.md
- um-remove.md: platform/pgedge_commands/doc/um-remove.md
- um-update.md: platform/pgedge_commands/doc/um-update.md
- um-upgrade.md: platform/pgedge_commands/doc/um-upgrade.md
- um-verify-metadata.md: platform/pgedge_commands/doc/um-verify-metadata.md
- pgEdge Distributed Postgres VM Edition Release Notes: platform/pgedge_rel_notes.md
- Troubleshooting: platform/troubleshooting.md
- pgEdge Cloud:
- Cloud Edition - Overview: cloud/index.md
- Getting Started with pgEdge Cloud: cloud/getting_started/getting_started.md
- Prerequisites:
- Adding an SSH Key: cloud/prerequisites/ssh_key.md
- Linking and Managing your Cloud Provider Accounts:
- Managing Cloud Provider Accounts: cloud/prerequisites/cloud_accounts/index.md
- Linking an AWS Account: cloud/prerequisites/cloud_accounts/link_to_AWS.md
- Linking an Azure Account: cloud/prerequisites/cloud_accounts/link_to_Azure.md
- Linking a Google Account: cloud/prerequisites/cloud_accounts/link_to_Google.md
- Cluster Management:
- Reviewing your Cloud Clusters: cloud/cluster/index.md
- Creating a Cluster: cloud/cluster/create_cluster.md
- Managing a Cluster: cloud/cluster/manage_cluster.md
- Defining a Cluster's Backup Store: cloud/cluster/backup_store.md
- Managing Firewall Rules: cloud/cluster/firewall.md
- Using Resource Tags: cloud/cluster/resource_tag.md
- Managing VPC Associations: cloud/cluster/vpc_assoc.md
- Database Management:
- Reviewing your Databases: cloud/database/index.md
- Creating a Database: cloud/database/create_db.md
- Managing a Database: cloud/database/manage_db.md
- Modifying a Database or a Cluster:
- Using the Actions Menu: cloud/mod_cluster/actions.md
- Adding a Database or Cluster Node: cloud/mod_cluster/add.md
- Dropping a Database, Node, or Cluster: cloud/mod_cluster/drop.md
- Modifying a Database, Node, or Cluster: cloud/mod_cluster/modify.md
- Database Administration:
- Reviewing Database Metrics: cloud/database_admin/metrics.md
- Viewing Log Files: cloud/database_admin/logs.md
- Reviewing Backup Details: cloud/database_admin/backup_details.md
- Using Extensions with Cloud: cloud/database_admin/supported_extensions.md
- Connecting to a Database:
- Connecting to your Database or Cluster: cloud/connecting/index.md
- Connecting with SSH: cloud/connecting/ssh.md
- Connecting with psql: cloud/connecting/psql.md
- Connecting with pgAdmin: cloud/connecting/pgadmin.md
- Connecting a Custom Client: cloud/connecting/custom_client.md
- Best Practices for Managing Connections: cloud/connecting/best_practices.md
- Managing Database Backups:
- Reviewing Backup Details: cloud/backup/backups.md
- Backing up your Database: cloud/backup/backup_providers.md
- Restoring from Backup: cloud/backup/restore.md
- Reviewing Console Tasks: cloud/tasks.md
- Migrating to pgEdge Distributed Postgres (Cloud Edition):
- Overview - Using a Backup to Migrate into a Distributed Database: cloud/migration/index.md
- Taking a Backup: cloud/migration/backup.md
- Restoring from Backup: cloud/migration/restore.md
- Settings: cloud/settings.md
- Team Resources: cloud/teams.md
- Troubleshooting: cloud/troubleshooting.md
- pgEdge Container:
- Overview: pgedge-container/index.md
- pgEdge Enterprise Postgres for Kubernetes:
- Overview: kubernetes/index.md
- Installation: kubernetes/install.md
- Upgrading: kubernetes/upgrade.md
- pgEdge Container Registry:
- Overview: container-images/index.md
- pgEdge Enterprise Postgres Images: container-images/postgres-images.md
- pgEdge Helm: pgedge-container/helm.md
# Pinned to latest release - this should be updated when a new release is cut
# Macro variables under extra also need to be updated, if changed
- pgEdge Helm:
- v0.2: '!import https://github.com/pgEdge/pgedge-helm.git?branch=v0.2.0'
- v0.1: '!import https://github.com/pgEdge/pgedge-helm.git?branch=v0.1.0-docs'
- Development: '!import https://github.com/pgEdge/pgedge-helm.git?branch=main'
- ACE:
- v1.7.1: '!import https://github.com/pgEdge/ace.git?branch=v1.7.1'
- v1.7.0: '!import https://github.com/pgEdge/ace.git?branch=v1.7.0'
- v1.6.0: '!import https://github.com/pgEdge/ace.git?branch=v1.6.0'
- v1.5.5: '!import https://github.com/pgEdge/ace.git?branch=v1.5.5'
- v1.5.4: '!import https://github.com/pgEdge/ace.git?branch=v1.5.4'
- v1.5.3: '!import https://github.com/pgEdge/ace.git?branch=v1.5.3'
- v1.5.2: '!import https://github.com/pgEdge/ace.git?branch=v1.5.2'
- v1.5.1: '!import https://github.com/pgEdge/ace.git?branch=fix-for-1.5.1-docs'
- v1.4.2: '!import https://github.com/pgEdge/ace.git?branch=v1.4.2'
- v1.4.1: '!import https://github.com/pgEdge/ace.git?branch=v1.4.1'
- v1.4.0: '!import https://github.com/pgEdge/ace.git?branch=v1.4.0'
- Development: '!import https://github.com/pgEdge/ace.git?branch=main'
- lolor:
- v1.2.2: '!import https://github.com/pgEdge/lolor.git?branch=v1.2.2'
- Development: '!import https://github.com/pgEdge/lolor.git?branch=main'
- Snowflake:
- v2.4: '!import https://github.com/pgEdge/snowflake.git?branch=v2.4'
- Development: '!import https://github.com/pgEdge/snowflake.git?branch=main'
- Spock v5:
- v5.0.6: '!import https://github.com/pgEdge/spock.git?branch=v5_STABLE'
- v5.0.5: '!import https://github.com/pgEdge/spock.git?branch=v5.0.5'
- v5.0.4: '!import https://github.com/pgEdge/spock.git?branch=v5.0.4'
- Development: '!import https://github.com/pgEdge/spock.git?branch=main'
- Control Plane:
- v0.7: '!import https://github.com/pgEdge/control-plane.git?branch=release/v0.7.0'
- v0.6: '!import https://github.com/pgEdge/control-plane.git?branch=v0.6.2-docs'
- Development: '!import https://github.com/pgEdge/control-plane.git?branch=main'
- Radar:
- v0.3.0: '!import https://github.com/pgEdge/radar?branch=v0.3.0'
- v0.2.3: '!import https://github.com/pgEdge/radar?branch=v0.2.3'
- v0.2.2: '!import https://github.com/pgEdge/radar?branch=v0.2.2'
- v0.1.0: '!import https://github.com/pgEdge/radar?branch=v0.1.0'
- Development: '!import https://github.com/pgEdge/radar?branch=main'
- pgEdge Loadgen:
- v1.0.0-beta1: '!import https://github.com/pgEdge/pgedge-loadgen?branch=v1.0.0-beta1'
- Development: '!import https://github.com/pgEdge/pgedge-loadgen?branch=main'
# AI Toolkit - pgEdge Postgres MCP Server (versioned documentation)
# Each version is imported separately to enable version navigation
# Latest version first, older versions next, development (main branch) last
- pgEdge Postgres MCP Server:
- v1.0.0: '!import https://github.com/pgEdge/pgedge-postgres-mcp?branch=v1.0.0'
- Development: '!import https://github.com/pgEdge/pgedge-postgres-mcp?branch=main'
- pgEdge Anonymizer:
- v1.0.0: '!import https://github.com/pgEdge/pgedge-anonymizer?branch=v1.0.0'
- Development: '!import https://github.com/pgEdge/pgedge-anonymizer?branch=main'
- pgEdge Docloader:
- v1.0.0: '!import https://github.com/pgEdge/pgedge-docloader?branch=v1.0.0'
- Development: '!import https://github.com/pgEdge/pgedge-docloader?branch=main'
- pgEdge RAG Server:
- v1.0.0: '!import https://github.com/pgEdge/pgedge-rag-server?branch=v1.0.0'
- Development: '!import https://github.com/pgEdge/pgedge-rag-server?branch=main'
- pgEdge Vectorizer:
- v1.0: '!import https://github.com/pgEdge/pgedge-vectorizer?branch=v1.0'
- Development: '!import https://github.com/pgEdge/pgedge-vectorizer?branch=main'
- AI DBA Workbench:
- v1.0.0-beta1: '!import https://github.com/pgEdge/ai-dba-workbench.git?branch=v1.0.0-beta1'
- Development: '!import https://github.com/pgEdge/ai-dba-workbench.git?branch=main'
# --- pgEdge Labs ---
- pg-semantic-cache:
- v0.1.0-beta4: '!import https://github.com/pgEdge/pg_semantic_cache?branch=v0.1.0-beta4'
- Development: '!import https://github.com/pgEdge/pg_semantic_cache?branch=main'
- pgedge-safesession:
- Development: '!import https://github.com/pgEdge/pgedge-safesession?branch=main'
- pgedge-mcp-bridge:
- v1.0.0-alpha5: '!import https://github.com/pgEdge/pgedge-mcp-bridge?branch=v1.0.0-alpha5'
- Development: '!import https://github.com/pgEdge/pgedge-mcp-bridge?branch=main'
- PostgreSQL:
- v18: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pg18'
- v17: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pg17'
- v16: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pg16'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pg19'
# Community Extensions (from 3rd-party-docs repo)
- pgvector:
- v0.8.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgvector081'
- v0.8.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgvector080'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgvectormaster'
- postgis:
- v3.6.2: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=postgis362'
- v3.5.5: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=postgis355'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=postgismaster'
- pgAudit:
- v18.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgaudit180'
- v17.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgaudit171'
- v16.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgaudit161'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgauditmaster'
# AI Toolkit - Community Extensions (from 3rd-party-docs repo)
- pg-tokenizer:
- v0.1.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgtokenizer011'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgtokenizermaster'
- pg-vectorize:
- v0.26.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgvectorize0260'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgvectorizemaster'
- vchord-bm25:
- v0.3.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=vchordbm25030'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=vchordbm25master'
# Community Extensions - Database (from 3rd-party-docs repo)
- pg-cron:
- v1.6.7: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgcron167'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgcronmaster'
- pgmq:
- v1.11.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgmq1110'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgmqmaster'
- pg-stat-monitor:
- v2.3.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgstatmonitor231'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgstatmonitormaster'
- pldebugger:
- v1.9: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pldebugger19'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pldebuggermaster'
- system-stats:
- v3.2.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=systemstats321'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=systemstatsmaster'
# Community Tools (from 3rd-party-docs repo)
- pgAdmin 4:
- v9.13: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgadmin913'
- v9.12: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgadmin912'
- v9.11: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgadmin911'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgadminmaster'
- PgBouncer:
- v1.25: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbouncer125'
- v1.24: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbouncer124'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbouncermaster'
- postgrest:
- v14.5: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=postgrest145'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=postgrestmaster'
- psycopg2:
- v2.9.10: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=psycopg2910'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=psycopg2master'
- pgBackRest:
- v2.58.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbackrest258'
- v2.57.0: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbackrest257'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=pgbackrestmaster'
- CloudNativePG:
- v1.29: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=cnpg129'
- v1.28: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=cnpg128'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=cnpgmaster'
- Patroni:
- v4.1.1: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=patroni411'
- Development: '!import https://github.com/pgEdge/3rd-party-docs.git?branch=patronimaster'