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

Commit

Permalink
Getting started doc fixes (#375)
Browse files Browse the repository at this point in the history
* Fix kind code snippets that weren't showing

* Fix the order of the steps.
  • Loading branch information
antweiss committed Jan 6, 2021
1 parent 1f223ac commit f0e7cb2
Showing 1 changed file with 30 additions and 17 deletions.
47 changes: 30 additions & 17 deletions docs/start/install.rst
Expand Up @@ -28,16 +28,20 @@ Setting up kind clusters
Lets write a ``kind.yaml`` manifest to configure our clusters:

.. code-block:: yaml
:caption: kind.yaml
kind: Cluster
apiVersion: kind.x-k8s.io/v1alpha4
nodes:
- role: control-plane
Now we'll use this to create the clusters:

.. code-block:: shell
$ kind create cluster --name app --config kind.yaml --image kindest/node:v1.15.7
$ kind create cluster --name mgmt --config kind.yaml --image kindest/node:v1.15.7
Congratulations, you have created your clusters!

**************************
Expand Down Expand Up @@ -81,6 +85,7 @@ Copy the URL of the server.
Now let's write a ``clusters.yaml`` manifest to configure Shipper here:

.. code-block:: yaml
:caption: clusters.yaml
applicationClusters:
Expand All @@ -91,7 +96,7 @@ Now let's write a ``clusters.yaml`` manifest to configure Shipper here:
Paste your server URL as a string.

**************************
Step 3: apply the manifest
Step 3: Setup the Management Cluster
**************************

Before you run ``shipperctl``, make sure that your ``kubectl`` context
Expand All @@ -105,8 +110,7 @@ is set to the management cluster:
* kind-mgmt kind-mgmt kind-mgmt
Now we'll give ``clusters.yaml`` to ``shipperctl`` to configure the cluster for
Shipper:
First we'll setup all the needed resources in the management cluster:

.. code-block:: shell
Expand All @@ -123,19 +127,6 @@ Shipper:
Creating a Service object for the validating webhook... done
Finished setting up management cluster
$ shipperctl clusters join -f clusters.yaml -n shipper-system
Creating application cluster accounts in cluster kind-app:
Creating a namespace called shipper-system... already exists. Skipping
Creating a service account called shipper-application-cluster... already exists. Skipping
Creating a ClusterRoleBinding called shipper:application-cluster... already exists. Skipping
Finished creating application cluster accounts in cluster kind-app
Joining management cluster to application cluster kind-app:
Creating or updating the cluster object for cluster kind-app on the management cluster... done
Checking whether a secret for the kind-app cluster exists in the shipper-system namespace... yes. Skipping
Finished joining management cluster to application cluster kind-app
.. _deploy-shipper:
**********************
Step 4: deploy shipper
Expand All @@ -151,8 +142,30 @@ service accounts, and so on, let's create the Shipper *Deployment*:
This will create an instance of Shipper in the ``shipper-system`` namespace.
.. join-clusters:
**********************
Step 5: Join the Application cluster to the Management cluster
**********************
Now we'll give ``clusters.yaml`` to ``shipperctl`` to configure the cluster for
Shipper:
.. code-block:: shell
$ shipperctl clusters join -f clusters.yaml -n shipper-system
Creating application cluster accounts in cluster kind-app:
Creating a namespace called shipper-system... already exists. Skipping
Creating a service account called shipper-application-cluster... already exists. Skipping
Creating a ClusterRoleBinding called shipper:application-cluster... already exists. Skipping
Finished creating application cluster accounts in cluster kind-app
Joining management cluster to application cluster kind-app:
Creating or updating the cluster object for cluster kind-app on the management cluster... done
Checking whether a secret for the kind-app cluster exists in the shipper-system namespace... yes. Skipping
Finished joining management cluster to application cluster kind-app
*********************
Step 5: do a rollout!
Step 6: do a rollout!
*********************
Now you should have a working Shipper installation. :ref:`Let's roll something out! <user_rolling-out>`
Expand Down

0 comments on commit f0e7cb2

Please sign in to comment.