Skip to content

Commit a337dfc

Browse files
xenophenesxenophenes
committed
Publishing documentation
1 parent cb3360f commit a337dfc

File tree

6 files changed

+103
-16
lines changed

6 files changed

+103
-16
lines changed

‎docs/crunchy-logo.jpg‎

98 KB
Loading

‎docs/images/home_bg.jpg‎

-181 KB
Loading

‎docs/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@
177177

178178
<div class="imageblock" style="text-align: center">
179179
<div class="content">
180-
<img src="crunchy_logo.png" alt="Crunchy Data Logo" width="12%" height="12%">
180+
<img src="crunchy-logo.jpg" alt="Crunchy Data Logo" width="12%" height="12%">
181181
</div>
182182
</div>
183183
<div class="paragraph">

‎docs/index.json‎

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

‎docs/installation/configuration/index.html‎

Lines changed: 99 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -569,6 +569,10 @@ <h3 id="_pgo_rbac">pgo RBAC</h3>
569569
<td class="tableblock halign-left valign-top"><p class="tableblock">allow <strong>pgo failover</strong></p></td>
570570
</tr>
571571
<tr>
572+
<td class="tableblock halign-left valign-top"><p class="tableblock">ShowConfig</p></td>
573+
<td class="tableblock halign-left valign-top"><p class="tableblock">allow <strong>pgo show config</strong></p></td>
574+
</tr>
575+
<tr>
572576
<td class="tableblock halign-left valign-top"><p class="tableblock">User</p></td>
573577
<td class="tableblock halign-left valign-top"><p class="tableblock">allow <strong>pgo user</strong></p></td>
574578
</tr>
@@ -1080,6 +1084,9 @@ <h2 id="_rest_api">REST API</h2>
10801084
application code. To demonstrate this, the following <strong>curl</strong> commands show the API usage -</p>
10811085
</div>
10821086
<div class="paragraph">
1087+
<p>Note: Some setups may require the user to add '?version=x.x' to the end of the commands.</p>
1088+
</div>
1089+
<div class="paragraph">
10831090
<p><strong>pgo version</strong></p>
10841091
</div>
10851092
<div class="literalblock">
@@ -1088,51 +1095,131 @@ <h2 id="_rest_api">REST API</h2>
10881095
</div>
10891096
</div>
10901097
<div class="paragraph">
1091-
<p><strong>pgo show policy all</strong></p>
1098+
<p><strong>pgo show policy &lt;name&gt;</strong></p>
1099+
</div>
1100+
<div class="literalblock">
1101+
<div class="content">
1102+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/&lt;name&gt;</pre>
1103+
</div>
1104+
</div>
1105+
<div class="paragraph">
1106+
<p><strong>pgo delete policy &lt;name&gt;</strong></p>
1107+
</div>
1108+
<div class="literalblock">
1109+
<div class="content">
1110+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policiesdelete/&lt;name&gt;</pre>
1111+
</div>
1112+
</div>
1113+
<div class="paragraph">
1114+
<p><strong>pgo show pvc &lt;name&gt;</strong></p>
1115+
</div>
1116+
<div class="literalblock">
1117+
<div class="content">
1118+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/pvc/&lt;name&gt;</pre>
1119+
</div>
1120+
</div>
1121+
<div class="paragraph">
1122+
<p><strong>pgo apply policy &lt;name&gt;</strong></p>
1123+
</div>
1124+
<div class="literalblock">
1125+
<div class="content">
1126+
<pre>curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/apply/&lt;name&gt;</pre>
1127+
</div>
1128+
</div>
1129+
<div class="paragraph">
1130+
<p><strong>pgo show ingest &lt;name&gt;</strong></p>
1131+
</div>
1132+
<div class="literalblock">
1133+
<div class="content">
1134+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/ingest/&lt;name&gt;</pre>
1135+
</div>
1136+
</div>
1137+
<div class="paragraph">
1138+
<p><strong>pgo label</strong></p>
1139+
</div>
1140+
<div class="literalblock">
1141+
<div class="content">
1142+
<pre>curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/label</pre>
1143+
</div>
1144+
</div>
1145+
<div class="paragraph">
1146+
<p><strong>pgo load</strong></p>
1147+
</div>
1148+
<div class="literalblock">
1149+
<div class="content">
1150+
<pre>curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/load</pre>
1151+
</div>
1152+
</div>
1153+
<div class="paragraph">
1154+
<p><strong>pgo user</strong></p>
1155+
</div>
1156+
<div class="literalblock">
1157+
<div class="content">
1158+
<pre>curl -v -X POST -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/user</pre>
1159+
</div>
1160+
</div>
1161+
<div class="paragraph">
1162+
<p><strong>pgo users &lt;name&gt;</strong></p>
1163+
</div>
1164+
<div class="literalblock">
1165+
<div class="content">
1166+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/users/&lt;name&gt;</pre>
1167+
</div>
1168+
</div>
1169+
<div class="paragraph">
1170+
<p><strong>pgo delete user &lt;name&gt;</strong></p>
1171+
</div>
1172+
<div class="literalblock">
1173+
<div class="content">
1174+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/usersdelete/&lt;name&gt;</pre>
1175+
</div>
1176+
</div>
1177+
<div class="paragraph">
1178+
<p><strong>pgo show upgrade &lt;name&gt;</strong></p>
10921179
</div>
10931180
<div class="literalblock">
10941181
<div class="content">
1095-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/policies/all</pre>
1182+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgrades/&lt;name&gt;</pre>
10961183
</div>
10971184
</div>
10981185
<div class="paragraph">
1099-
<p><strong>pgo show pvc danger</strong></p>
1186+
<p><strong>pgo delete upgrade &lt;name&gt;</strong></p>
11001187
</div>
11011188
<div class="literalblock">
11021189
<div class="content">
1103-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/pvc/danger</pre>
1190+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgradesdelete/&lt;name&gt;</pre>
11041191
</div>
11051192
</div>
11061193
<div class="paragraph">
1107-
<p><strong>pgo show cluster mycluster</strong></p>
1194+
<p><strong>pgo show cluster &lt;name&gt;</strong></p>
11081195
</div>
11091196
<div class="literalblock">
11101197
<div class="content">
1111-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/mycluster</pre>
1198+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/&lt;name&gt;</pre>
11121199
</div>
11131200
</div>
11141201
<div class="paragraph">
1115-
<p><strong>pgo show upgrade mycluster</strong></p>
1202+
<p><strong>pgo delete cluster</strong></p>
11161203
</div>
11171204
<div class="literalblock">
11181205
<div class="content">
1119-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/upgrades/mycluster</pre>
1206+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clustersdelete/&lt;name&gt;</pre>
11201207
</div>
11211208
</div>
11221209
<div class="paragraph">
1123-
<p><strong>pgo test mycluster</strong></p>
1210+
<p><strong>pgo test &lt;name&gt;</strong></p>
11241211
</div>
11251212
<div class="literalblock">
11261213
<div class="content">
1127-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/test/mycluster</pre>
1214+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/test/&lt;name&gt;</pre>
11281215
</div>
11291216
</div>
11301217
<div class="paragraph">
1131-
<p><strong>pgo show backup mycluster</strong></p>
1218+
<p><strong>pgo scale &lt;name&gt;</strong></p>
11321219
</div>
11331220
<div class="literalblock">
11341221
<div class="content">
1135-
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/backups/mycluster</pre>
1222+
<pre>curl -v -X GET -u readonlyuser:testpass -H "Content-Type: application/json" --insecure https://10.101.155.218:8443/clusters/scale/&lt;name&gt;</pre>
11361223
</div>
11371224
</div>
11381225
</div>

‎docs/installation/manual-installation/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -370,7 +370,7 @@ <h3 id="_create_hostpath_directory">Create HostPath Directory</h3>
370370
<div class="literalblock">
371371
<div class="content">
372372
<pre>sudo mkdir /data
373-
sudo chown 777 /data</pre>
373+
sudo chmod 777 /data</pre>
374374
</div>
375375
</div>
376376
<div class="paragraph">

0 commit comments

Comments
 (0)