diff --git a/docs/cluster-configuration.md b/docs/cluster-configuration.md new file mode 100644 index 0000000..51c8cd4 --- /dev/null +++ b/docs/cluster-configuration.md @@ -0,0 +1,25 @@ +## Creating Namespace and Roles + +`calrissian` executes CWL workflows by running steps as Pods in a kubernetes cluster. + +To support this requirement, we create a role with the necessary privileges and bind it to a service account. + +### Create the Namespace + +``` +NAMESPACE_NAME=calrissian-demo-project +kubectl create namespace "$NAMESPACE_NAME" +``` + +### Create the Roles and RoleBindings + +``` +kubectl --namespace="$NAMESPACE_NAME" create role pod-manager-role \ + --verb=create,patch,delete,list,watch --resource=pods +kubectl --namespace="$NAMESPACE_NAME" create role log-reader-role \ + --verb=get,list --resource=pods/log +kubectl --namespace="$NAMESPACE_NAME" create rolebinding pod-manager-default-binding \ + --role=pod-manager-role --serviceaccount=${NAMESPACE_NAME}:default +kubectl --namespace="$NAMESPACE_NAME" create rolebinding log-reader-default-binding \ + --role=log-reader-role --serviceaccount=${NAMESPACE_NAME}:default +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 2100414..cc0922c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -8,7 +8,7 @@ Calrissian is a [CWL](https://www.commonwl.org) implementation designed to run i ## Cluster Requirements -Calrissian requires a [Kubernetes](https://kubernetes.io) cluster, configured to provision [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) with the `ReadWriteMany` access mode. +Calrissian requires a [Kubernetes](https://kubernetes.io) cluster, configured to provision [PersistentVolumes](https://kubernetes.io/docs/concepts/storage/persistent-volumes/) with the [ReadWriteMany](https://kubernetes.io/docs/concepts/storage/persistent-volumes/#access-modes) access mode. ## Scalability / Resource Requirements diff --git a/docs/conformance/1.0/result-1-0.txt b/docs/result-1-0.txt similarity index 100% rename from docs/conformance/1.0/result-1-0.txt rename to docs/result-1-0.txt diff --git a/mkdocs.yml b/mkdocs.yml index e584380..a1ff5e7 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -24,6 +24,7 @@ plugins: nav: - Introduction: 'index.md' - Installation: 'installation.md' +- Cluster Configuration: 'cluster-configuration.md' - Conformance: - 1.0: 'conformance/1.0/conformance.md' - 1.1: 'conformance/1.0/conformance.md'