From a6ab7fb51040d8366b9f3ed5fb928da545e91531 Mon Sep 17 00:00:00 2001 From: Cynthia Shang Date: Thu, 5 Apr 2018 13:31:51 -0400 Subject: [PATCH 1/2] Some minor tweaks for asciidoc conformity. --- docs/commands.asciidoc | 1 + docs/configuration.asciidoc | 2 +- docs/design.asciidoc | 20 +++++++++----------- 3 files changed, 11 insertions(+), 12 deletions(-) diff --git a/docs/commands.asciidoc b/docs/commands.asciidoc index 2d214e1700..fac5d142a3 100644 --- a/docs/commands.asciidoc +++ b/docs/commands.asciidoc @@ -545,6 +545,7 @@ The load configuration file has the following YAML attributes: .Load Configuration File Definitions [width="90%",cols="m,2",frame="topbot",options="header"] |====================== +|Attribute | Description |COImagePrefix| the pgo-load image prefix to use for the load job |COImageTag| the pgo-load image tag to use for the load job |DbDatabase| the database schema to use for loading the data diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 96e6a925fe..5df76cec3c 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -126,7 +126,7 @@ readonlyuser:testpass:pgoreader The following list shows the current *pgo* permissions: .pgo Permissions -[width="60%",frame="topbot",options="header,footer"] +[width="60%",frame="topbot",options="header"] |====================== |Permission | Description |ShowCluster | allow *pgo show cluster* diff --git a/docs/design.asciidoc b/docs/design.asciidoc index 30f2f93d74..a9099b1fbc 100644 --- a/docs/design.asciidoc +++ b/docs/design.asciidoc @@ -2,9 +2,6 @@ :toc: v2.6, {docdate} - -image::crunchy_logo.png?raw=true[] - == Reference Architecture So, what does the Postgres Operator actually deploy @@ -127,7 +124,7 @@ kubectl get pod -o wide .... When you scale up a Cluster and add a replica, the scaling will -take into account the use of "--node-name". If it sees that a +take into account the use of ``--node-name''. If it sees that a cluster was created with a specific node name, then the replica Deployment will add an affinity rule to attempt to schedule the replica on a different node than the node the primary is @@ -212,13 +209,14 @@ that gets mounted into */operator-conf* within the operator pod. The directory structure of the strategy templates is as follows: .... -├── backup-job.json -├── cluster -│   └── 1 -│   ├── cluster-deployment-1.json -│   ├── cluster-replica-deployment-1.json -│   └── cluster-service-1.json -├── pvc.json +|-- backup-job.json +|-- cluster +| |-- 1 +| |-- cluster-deployment-1.json +| |-- cluster-replica-deployment-1.json +| |-- cluster-service-1.json +| +|-- pvc.json .... In this structure, each strategy's templates live in a subdirectory From 84ea16dfcee5a639e881c35286660e73026e7421 Mon Sep 17 00:00:00 2001 From: Cynthia Shang Date: Fri, 6 Apr 2018 11:46:54 -0400 Subject: [PATCH 2/2] Fixed level issue reported by asciidoc: build.asciidoc: line 49: section title out of sequence: expected level 2, got level 3. Removed footer option since there was none in the table. --- docs/build.asciidoc | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/build.asciidoc b/docs/build.asciidoc index ac31c3982d..fdc166dfcf 100644 --- a/docs/build.asciidoc +++ b/docs/build.asciidoc @@ -46,7 +46,7 @@ cd $COROOT make setup .... -==== Compiling the PostgreSQL Operator +=== Compiling the PostgreSQL Operator .... cd $COROOT make all @@ -163,7 +163,7 @@ export CO_APISERVER_URL=https://postgres-operator.demo.svc.cluster.local:8443 The following table describes the Makefile targets: .Makefile Targets -[width="80%",frame="topbot",options="header,footer"] +[width="80%",frame="topbot",options="header"] |====================== |Target | Description |all | compile all binaries and build all images @@ -182,5 +182,3 @@ The following table describes the Makefile targets: |rmdataimage | build the data deletion Docker image |release | build the postgres-operator release |====================== - -