Skip to content

Commit 77dc312

Browse files
gbartolinisxdtheadamwrightjlong49mnencia
authored
docs: add section about "OpenShift" in the documentation
Cover installation of the operator via the web console and the `oc` command-line interface (CLI), as well as some important OpenShift topics like RBAC policies, operator groups, subscriptions, cluster roles, service accounts, and so on. Co-authored-by: Jonathan Gonzalez V <jonathan.gonzalez@enterprisedb.com> Co-authored-by: Adam Wright <adam.wright@enterprisedb.com> Co-authored-by: John Long <john.long@enterprisedb.com> Co-authored-by: Marco Nenciarini <marco.nenciarini@enterprisedb.com> Co-authored-by: Leonardo Cecchi <leonardo.cecchi@enterprisedb.com>
1 parent 4cd2f10 commit 77dc312

20 files changed

Lines changed: 779 additions & 50 deletions

‎.wordlist-en-custom.txt‎

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ CRC
3737
CRD
3838
CRDs
3939
CSV
40+
CSVs
4041
Canovai
4142
Cecchi
4243
CertificatesConfiguration
@@ -47,14 +48,17 @@ ClientCertsCASecret
4748
ClientReplicationSecret
4849
ClusterCondition
4950
ClusterConditionType
50-
ConditionStatus
5151
ClusterIP
5252
ClusterList
53+
ClusterRole
54+
ClusterRole's
55+
ClusterServiceVersion
5356
ClusterSpec
5457
ClusterStatus
5558
CodeReady
5659
ColumnName
5760
CompressionType
61+
ConditionStatus
5862
ConfigMap
5963
ConfigMapKeySelector
6064
ConfigMapResourceVersion
@@ -66,6 +70,7 @@ CronJobs
6670
CustomResourceDefinition
6771
CustomResourceDefinitions
6872
Customizations
73+
DDTHH
6974
DISA
7075
DNS
7176
DataBackupConfiguration
@@ -151,6 +156,7 @@ ObjectMeta
151156
OnlineUpdateEnabled
152157
OpenShift
153158
Openshift
159+
OperatorGroup
154160
OperatorHub
155161
PGAudit
156162
PGDATA
@@ -220,6 +226,7 @@ SELinux
220226
SHA
221227
SQLQuery
222228
SSL
229+
SSZ
223230
STORAGEACCOUNTNAME
224231
ScheduledBackup
225232
ScheduledBackupList
@@ -235,6 +242,7 @@ Seealso
235242
ServerCASecret
236243
ServerTLSSecret
237244
ServiceAccount
245+
ServiceAccount's
238246
ServiceMonitor
239247
Silvela
240248
StorageClass
@@ -258,7 +266,9 @@ WALs
258266
Wadle
259267
WalBackupConfiguration
260268
YXBw
269+
YY
261270
YYYY
271+
abd
262272
accessKeyId
263273
accessModes
264274
adc
@@ -267,12 +277,15 @@ addons
267277
affinityconfiguration
268278
aks
269279
albert
280+
allnamespaces
270281
alloc
271282
allocator
272283
allowPrivilegeEscalation
273284
allowVolumeExpansion
274285
angus
275286
api
287+
apiGroup
288+
apiGroups
276289
apiVersion
277290
apidoc
278291
apis
@@ -320,6 +333,7 @@ ce
320333
cheatsheet
321334
checksums
322335
chmod
336+
cioni
323337
cisecurity
324338
claimRef
325339
clair
@@ -329,6 +343,7 @@ clientCASecret
329343
clusterBackup
330344
clusterName
331345
clusterlist
346+
clusterrole
332347
clusterspec
333348
clusterstatus
334349
cmd
@@ -357,13 +372,16 @@ coverity
357372
cp
358373
cpu
359374
crc
375+
crds
376+
crdview
360377
createuser
361378
creationTimestamp
362379
creds
363380
cron
364381
crt
365382
cryptographic
366383
csvlog
384+
csvs
367385
ctl
368386
currentPrimary
369387
customQueriesConfigMap
@@ -379,12 +397,14 @@ datacenters
379397
datallowconn
380398
datistemplate
381399
datname
400+
dbe
382401
dbname
383402
ddl
384403
de
385404
declaratively
386405
defaultMode
387406
defaultPoolSize
407+
deployer
388408
destinationPath
389409
dev
390410
devel
@@ -412,6 +432,7 @@ externalClusters
412432
facto
413433
failover
414434
fastpath
435+
fb
415436
fd
416437
ffd
417438
filesystem
@@ -496,6 +517,7 @@ lsn
496517
lt
497518
malcolm
498519
mallocs
520+
mario
499521
matchExpressions
500522
matchLabels
501523
maxClientConnections
@@ -518,6 +540,7 @@ monitoringconfiguration
518540
mountPath
519541
msg
520542
mspan
543+
multinamespace
521544
myAKSCluster
522545
myResourceGroup
523546
namespace
@@ -545,8 +568,12 @@ ol
545568
olm
546569
openshift
547570
operatorframework
571+
operatorgorup
572+
operatorgroup
548573
operatorgroups
549574
operatorhub
575+
osdk
576+
packagemanifests
550577
parseable
551578
passwd
552579
pc
@@ -593,6 +620,7 @@ prepended
593620
primaryUpdateStrategy
594621
proc
595622
programmatically
623+
proj
596624
prometheus
597625
provisioner
598626
psql
@@ -623,6 +651,7 @@ resourcerequirements
623651
retentionPolicy
624652
reusePVC
625653
robfig
654+
roleRef
626655
rollingupdatestatus
627656
rollout
628657
runonserver
@@ -649,12 +678,15 @@ securityContext
649678
serverCASecret
650679
serverName
651680
serverTLSSecret
681+
serviceaccount
652682
sha
653683
shm
654684
shmall
655685
shmmax
656686
sig
657687
sigs
688+
singlenamespace
689+
sourceNamespace
658690
specificities
659691
sql
660692
src
@@ -701,6 +733,7 @@ tablespaces
701733
targetImmediate
702734
targetLSN
703735
targetName
736+
targetNamespaces
704737
targetPort
705738
targetPrimary
706739
targetTLI
@@ -736,6 +769,7 @@ walSegmentSize
736769
walbackupconfiguration
737770
walkthrough
738771
walsender
772+
webconsole
739773
webhook
740774
webhooks
741775
webtest

‎Makefile‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,14 @@ shellcheck: ## Shellcheck for the hack directory.
145145
spellcheck: ## Runs the spellcheck on the project.
146146
docker run --rm -v $(PWD):/tmp jonasbn/github-action-spellcheck:0.14.0
147147

148-
woke: # Runs the woke checks on project.
148+
woke: ## Runs the woke checks on project.
149149
docker run --rm -v $(PWD):/src -w /src getwoke/woke:0.9 woke -c .woke.yaml
150150

151-
checks: generate manifests apidoc fmt spellcheck woke vet lint ## Runs all the checks on the project.
151+
wordlist-ordered: ## Order the wordlist using sort
152+
LANG=C sort .wordlist-en-custom.txt > .wordlist-en-custom.txt.new && \
153+
mv -f .wordlist-en-custom.txt.new .wordlist-en-custom.txt
154+
155+
checks: generate manifests apidoc fmt spellcheck wordlist-ordered woke vet lint ## Runs all the checks on the project.
152156

153157
##@ Documentation
154158

‎docs/mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,7 @@ nav:
3838
- kubernetes_upgrade.md
3939
- expose_pg_services.md
4040
- cnp-plugin.md
41+
- openshift.md
4142
- troubleshooting.md
4243
- e2e.md
4344
- container_images.md

‎docs/src/images/openshift/oc_installation_screenshot_1.png‎

33.8 KB
Loading

‎docs/src/images/openshift/oc_installation_screenshot_2.png‎

84 KB
Loading

‎docs/src/images/openshift/openshift-operatorgroup-error.png‎

33.9 KB
Loading

‎docs/src/images/openshift/openshift-rbac.png‎

164 KB
Loading

‎docs/src/images/openshift/openshift-webconsole-allnamespaces.png‎

77.7 KB
Loading

‎docs/src/images/openshift/openshift-webconsole-multinamespace.png‎

64.2 KB
Loading

‎docs/src/images/openshift/openshift-webconsole-singlenamespace-list.png‎

63.4 KB
Loading

0 commit comments

Comments
 (0)