Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
fabricebrito committed Nov 21, 2023
1 parent f28e7d9 commit d34c484
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 1 deletion.
25 changes: 25 additions & 0 deletions docs/cluster-configuration.md
Original file line number Diff line number Diff line change
@@ -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
```
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
File renamed without changes.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand Down

0 comments on commit d34c484

Please sign in to comment.