Skip to content

Commit

Permalink
Update Authorization Steps for CSM Operator (#456)
Browse files Browse the repository at this point in the history
* update authorization steps for operator

* fix typo

* update
  • Loading branch information
shaynafinocchiaro authored Feb 16, 2023
1 parent dd97eff commit 741a75a
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions content/docs/deployment/csmoperator/modules/authorization.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,9 +140,6 @@ To deploy the Operator, follow the instructions available [here](../../#installa
| --------- | ----------- | -------- |-------- |
| **authorization** | This section configures the CSM-Authorization components. | - | - |
| PROXY_HOST | The hostname to configure the self-signed certificate (if applicable), and the proxy, tenant, role, and storage service Ingresses. | Yes | csm-authorization.com |
| AUTHORIZATION_LOG_LEVEL | CSM Authorization log level. Allowed values: “error”, “warn”/“warning”, “info”, “debug”. | Yes | debug |
| AUTHORIZATION_ZIPKIN_COLLECTORURI | The URI of the Zipkin instance to export traces. | No | - |
| AUTHORIZATION_ZIPKIN_PROBABILITY | The ratio of traces to export. | No | - |
| PROXY_INGRESS_CLASSNAME | The ingressClassName of the proxy-service Ingress. | Yes | nginx |
| PROXY_INGRESS_HOSTS | Additional host rules to be applied to the proxy-service Ingress. | No | authorization-ingress-nginx-controller.authorization.svc.cluster.local |
| TENANT_INGRESS_CLASSNAME | The ingressClassName of the tenant-service Ingress. | Yes | nginx |
Expand All @@ -154,6 +151,15 @@ To deploy the Operator, follow the instructions available [here](../../#installa
| **cert-manager** | This section configures the enablement of cert-manager. | - | - |
| enabled | Enable/Disable deployment of cert-manager. Set to false if you already have cert-manager installed. | No | true |

**Optional:**
To enable reporting of trace data with [Zipkin](https://zipkin.io/), use the `csm-config-params` configMap in the sample CR or dynamically by editing the configMap.

Add the Zipkin values to the configMap:
```
ZIPKIN_URI: "http://PROXY_HOST:9411/api/v2/spans"
ZIPKIN_PROBABILITY: "1.0"
```

4. Execute this command to create the Authorization CR:

```kubectl create -f samples/authorization/csm_authorization_proxy_server.yaml```
Expand All @@ -173,6 +179,11 @@ To deploy the Operator, follow the instructions available [here](../../#installa

`kubectl create -f samples/authorization/certificate.yaml`

### Verify Installation of the CSM Authorization Proxy Server
Once the Authorization CR is created, you can verify the installation as mentioned below:

`kubectl describe csm/<name-of-custom-resource> -n <namespace>`

### Install Karavictl

Follow the instructions available in CSM Authorization for [Installing karavictl](../../../../authorization/deployment/helm/#install-karavictl).
Expand Down

0 comments on commit 741a75a

Please sign in to comment.