Skip to content

Commit 08043bd

Browse files
arschlesDoug Davis
authored andcommitted
Adding more small fixes to the walkthrough & install docs (#1169)
* CA -> Certificate Authority * Fixing grammar And declaring the abbreviation for “Certificate Authority” * Putting the installation dependency in bold * Putting resource names in code formatting * Changing naming from Bind => Delete * Clearing up naming & verbs around ServiceInstanceCredential * Plural => singular * Broker Server => Service Broker Server h/t @duglin
1 parent d65d4a1 commit 08043bd

File tree

3 files changed

+16
-16
lines changed

3 files changed

+16
-16
lines changed

docs/manual-api-aggregation-setup.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -83,12 +83,12 @@ export SVCCAT_SERVICE_NAME=${HELM_RELEASE_NAME}-catalog-apiserver
8383

8484
There are two options to get a CA and keys.
8585

86-
### Option 1 - Create Our Own CA and Generate Keys
86+
### Option 1 - Create Our Own Certificate Authority and Generate Keys
8787

8888
The `APIService` resource expects a certificate bundle. We can create our own,
8989
or pull the one core Kubernetes API server for reuse.
9090

91-
The certificate bundle is made up of Certificate Authority, a Serving
91+
The certificate bundle is made up of a Certificate Authority (CA), a Serving
9292
Certificate, and the Serving Private Key.
9393

9494
Run the following to create a CA and generate keys:

docs/walkthrough-1.6.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@ deprecated and may be removed at any time.
1111
If you are running a Kubernetes cluster running version 1.7 or later, please
1212
see [walkthrough-1.7.md](./walkthrough-1.7.md).
1313

14-
This document assumes that you've installed Service Catalog onto your cluster.
14+
__Note: This document assumes that you've installed Service Catalog onto your cluster.
1515
If you haven't, please see the
16-
[installation instructions for 1.6](./install-1.6.md).
16+
[installation instructions for 1.6](./install-1.6.md).__
1717

18-
# Step 1 - Installing the UPS ServiceBroker
18+
# Step 1 - Installing the UPS Service Broker Server
1919

2020
In order to effectively demonstrate the service catalog, we will require a
2121
sample broker server. To proceed, we will deploy the [User Provided Service
@@ -37,7 +37,7 @@ To install with defaults:
3737
helm install charts/ups-broker --name ups-broker --namespace ups-broker
3838
```
3939

40-
# Step 2 - Creating a ServiceBroker Resource
40+
# Step 2 - Creating a `ServiceBroker` Resource
4141

4242
Next, we'll register a broker server with the catalog by creating a new
4343
[`ServiceBroker`](../contrib/examples/walkthrough/ups-broker.yaml) resource.
@@ -99,7 +99,7 @@ Notice that the `status` field has been set to reflect that the broker server's
9999
catalog of service offerings has been successfully added to our cluster's
100100
service catalog.
101101

102-
# Step 3 - Viewing ServiceClasses
102+
# Step 3 - Viewing `ServiceClass`es
103103

104104
The controller created a `ServiceClass` for each service that the UPS broker
105105
provides. We can view the `ServiceClass` resources available in the cluster by
@@ -145,7 +145,7 @@ plans:
145145
externalID: 86064792-7ea2-467b-af93-ac9694d96d52
146146
```
147147

148-
# Step 4 - Provisioning a New ServiceInstance
148+
# Step 4 - Creating a New `ServiceInstance`
149149

150150
Now that a `ServiceClass` named `user-provided-service` exists within our
151151
cluster's service catalog, we can provision an instance of that. We do so by
@@ -204,7 +204,7 @@ status:
204204
type: Ready
205205
```
206206

207-
# Step 5 - ServiceInstanceCredential to the ServiceInstance
207+
# Step 5 - Requesting a `ServiceInstanceCredential` to use the `ServiceInstance`
208208

209209
Now that our `ServiceInstance` has been created, we can bind to it. To accomplish this,
210210
we will create a [`ServiceInstanceCredential`](../contrib/examples/walkthrough/ups-instance-credential.yaml)
@@ -277,9 +277,9 @@ ups-instance-credential Opaque 2
277277

278278
Notice that a new `Secret` named `ups-instance-credential` has been created.
279279

280-
# Step 6 - Unbinding from the ServiceInstance
280+
# Step 6 - Deleting the `ServiceInstanceCredential`
281281

282-
Now, let's unbind from the instance. To do this, we simply *delete* the
282+
Now, let's unbind from the provisioned instance. To do this, we simply *delete* the
283283
`ServiceInstanceCredential` resource that we previously created:
284284

285285
```console
@@ -295,16 +295,16 @@ NAME TYPE DATA AGE
295295
default-token-3k61z kubernetes.io/service-account-token 3 30m
296296
```
297297

298-
# Step 7 - Deprovisioning the ServiceInstance
298+
# Step 7 - Deleting the `ServiceInstance`
299299

300-
Now, we can deprovision the instance. To do this, we simply *delete* the
300+
Now, we can deprovision the instance. To do this, we simply *delete* the
301301
`ServiceInstance` resource that we previously created:
302302

303303
```console
304304
kubectl --context=service-catalog delete -n test-ns instances ups-instance
305305
```
306306

307-
# Step 8 - Deleting the ServiceBroker
307+
# Step 8 - Deleting the `ServiceBroker`
308308

309309
Next, we should remove the broker server, and the services it offers, from the catalog. We can do
310310
so by simply deleting the broker:

docs/walkthrough-1.7.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33
This document assumes that you've installed Service Catalog onto your cluster.
44
If you haven't, please see [install-1.7.md](./install-1.7.md).
55

6-
This document is a work in progress. Instructions for the self-guided demo
6+
__Note: This document is a work in progress. Instructions for the self-guided demo
77
will be similar to those in the [1.6 walkthrough](./walkthrough-1.6.md),
8-
but note that the commands in that document will not work as-is.
8+
but note that the commands in that document will not work as-is.__

0 commit comments

Comments
 (0)