Add documentation for kopia repository server controller workflow

docs/index.rst

@@ -21,7 +21,7 @@ and easy to install, operate and scale.
 
    overview
    install
-   tutorial
+   kanister_tutorial
    architecture
    tasks
    tooling

docs/install.rst

@@ -103,6 +103,23 @@ like below:
     --set bpValidatingWebhook.tls.caBundle=$(cat /path/to/ca.pem | base64 -w 0) \
     --set bpValidatingWebhook.tls.secretName=tls-secret
 
+.. _deploying_repo_server_controller:
+
+Deploying Kopia Repository server controller
+============================================
+
+Kopia Repository server controller is not enabled by default. It can be
+deployed by setting the `repositoryServerController.enabled` value as
+shown below
+
+.. substitution-code-block:: bash
+
+  helm upgrade --install kanister kanister/kanister-operator --namespace kanister --create-namespace \
+  --set repositoryServerController.enabled=true
+
+This will create another container in the kanister pod for kopia
+repository server controller.
+
 
 Building and Deploying from Source
 ==================================

docs/kanister_tutorial.rst

@@ -0,0 +1,9 @@
+.. _tutorials:
+
+Tutorials
+*********
+.. toctree::
+   :maxdepth: 1
+
+   tutorials/tutorial.rst
+   tutorials/tutorial_with_repositoryserver.rst

docs/overview.rst

@@ -35,7 +35,7 @@ Getting Started
 
 Follow the instructions in the :ref:`install` section to get Kanister up and
 running on your Kubernetes cluster. Then see Kanister in action by going through
-the walkthrough under :ref:`tutorial`.
+the walkthrough under :ref:`tutorials`.
 
 The :ref:`architecture` section provides architectural insights into how things
 work. We recommend that you take a look at it.

docs/templates.rst

@@ -22,6 +22,7 @@ The TemplateParam struct is defined as:
     Secrets          map[string]v1.Secret
     Time             string
     Profile          *Profile
+    RepositoryServer *RepositoryServer
     Options          map[string]string
     Object           map[string]interface{}
     Phases           map[string]*Phase
@@ -546,6 +547,52 @@ The currently supported Profile template is based on the following definitions
     Secret      ObjectReference
   }
 
+RepositoryServers
+-----------------
+
+RepositoryServers are a Kanister CustomResource that contains information about storage,
+repository and server details which are required for running a kopia repository server
+instance. Which could be further used for data operation artifacts.
+
+Unlike Secrets and ConfigMaps, only a single repository server can optionally be
+referenced by an ActionSet. As a result, it is not necessary to
+name the RepositoryServer in the Blueprint.
+
+The following examples should be helpful.
+
+.. code-block:: yaml
+
+  # Access the RepositoryServer name
+  "{{ .RepositoryServer.Name }}"
+
+  # Access the RepositoryServer service name
+  "{{ .RepositoryServer.ServerInfo.ServiceName }}"
+
+The currently supported RepositoryServer template is based on the following definitions
+
+.. code-block:: go
+  :linenos:
+
+  // RepositoryServer contains fields from Repository server CR that will be used to resolve go templates for repository server in blueprint
+  type RepositoryServer struct {
+    Name        string
+    Namespace   string
+    ServerInfo  crv1alpha1.ServerInfo
+    Username    string
+    Credentials RepositoryServerCredentials
+    Address     string
+  }
+
+  type RepositoryServerCredentials struct {
+    ServerTLS        v1.Secret
+    ServerUserAccess v1.Secret
+  }
+
+  type ServerInfo struct {
+    PodName     string `json:"podName,omitempty"`
+    ServiceName string `json:"serviceName,omitempty"`
+  }
+
 Options
 -------
 

docs/tutorial.rst → docs/tutorials/tutorial.rst

@@ -1,5 +1,3 @@
-.. _tutorial:
-
 Tutorial
 ********