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

Commit

Permalink
Update the docs with the namespace manager requirement
Browse files Browse the repository at this point in the history
  • Loading branch information
hihilla committed May 12, 2021
1 parent 9508399 commit 4c66fd4
Showing 1 changed file with 18 additions and 1 deletion.
19 changes: 18 additions & 1 deletion docs/start/install.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.. _start:

####################
Shipper in 5 minutes
Installing Shipper
####################

*************************
Expand Down Expand Up @@ -170,6 +170,23 @@ Step 6: do a rollout!
Now you should have a working Shipper installation. :ref:`Let's roll something out! <user_rolling-out>`
*****************
Namespace manager
*****************
By design, Shipper does not create namespaces in the application cluster.
Shipper requires the existence of a namespace in the application cluster with the same name as the namespace in
management cluster where the *Application* objects is installed.
In case the namespace does not exist in the application cluster, and this application cluster is selected for a *Release*,
Shipper will continue to try and install the charts, and fail.
This loop will end only when the namespace is created in the application cluster,
or this application cluster is not selected anymore (by deleting the *Release* or *Application* objects).
To help with this, we recommend having some sort of a namespace manager tool.
This can be a simple controller that installs a namespace in all the application clusters
for each namespace existing in the management cluster, or a more complex tool, depending on your needs.
.. rubric:: Footnotes
.. [#f1] For example, on GKE you need to `bind yourself to cluster-admin <https://stackoverflow.com/a/52972588>`_ before ``shipperctl`` will work.

0 comments on commit 4c66fd4

Please sign in to comment.