Skip to content
This repository has been archived by the owner on May 6, 2022. It is now read-only.

Commit

Permalink
Adding more small fixes to the walkthrough & install docs (#1169)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
arschles authored and Doug Davis committed Aug 30, 2017
1 parent d65d4a1 commit 08043bd
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/manual-api-aggregation-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,12 +83,12 @@ export SVCCAT_SERVICE_NAME=${HELM_RELEASE_NAME}-catalog-apiserver

There are two options to get a CA and keys.

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

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

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

Run the following to create a CA and generate keys:
Expand Down
24 changes: 12 additions & 12 deletions docs/walkthrough-1.6.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@ deprecated and may be removed at any time.
If you are running a Kubernetes cluster running version 1.7 or later, please
see [walkthrough-1.7.md](./walkthrough-1.7.md).

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

# Step 1 - Installing the UPS ServiceBroker
# Step 1 - Installing the UPS Service Broker Server

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

# Step 2 - Creating a ServiceBroker Resource
# Step 2 - Creating a `ServiceBroker` Resource

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

# Step 3 - Viewing ServiceClasses
# Step 3 - Viewing `ServiceClass`es

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

# Step 4 - Provisioning a New ServiceInstance
# Step 4 - Creating a New `ServiceInstance`

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

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

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

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

# Step 6 - Unbinding from the ServiceInstance
# Step 6 - Deleting the `ServiceInstanceCredential`

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

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

# Step 7 - Deprovisioning the ServiceInstance
# Step 7 - Deleting the `ServiceInstance`

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

```console
kubectl --context=service-catalog delete -n test-ns instances ups-instance
```

# Step 8 - Deleting the ServiceBroker
# Step 8 - Deleting the `ServiceBroker`

Next, we should remove the broker server, and the services it offers, from the catalog. We can do
so by simply deleting the broker:
Expand Down
4 changes: 2 additions & 2 deletions docs/walkthrough-1.7.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
This document assumes that you've installed Service Catalog onto your cluster.
If you haven't, please see [install-1.7.md](./install-1.7.md).

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

0 comments on commit 08043bd

Please sign in to comment.