-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add RPM deployment for Authorization (#1060)
* readd rpm deployment * fix page descriptions * fix broken links
- Loading branch information
1 parent
9b596fb
commit 7d234cb
Showing
14 changed files
with
365 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: "CSM modules" | ||
| linkTitle: "CSM modules" | ||
| description: Deployment of Dell CSM modules using helm | ||
| title: "CSM Modules" | ||
| linkTitle: "CSM Modules" | ||
| description: Deployment of Dell CSM Modules using helm | ||
| weight: 1 | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: "Installation" | ||
| linkTitle: "Installation" | ||
| description: Deployment of Dell CSM modules using helm | ||
| description: Deployment of Dell CSM Modules using helm | ||
| weight: 1 | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| --- | ||
| title: "Uninstallation" | ||
| linkTitle: "Uninstallation" | ||
| description: Uninstallation of Dell CSM modules using helm | ||
| description: Uninstallation of Dell CSM Modules using helm | ||
| weight: 1 | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| --- | ||
| title: "RPM" | ||
| linkTitle: "RPM" | ||
| description: RPM Deployment of Container Storage Modules | ||
| weight: 1 | ||
| --- | ||
|
|
||
| RPM Deployment of Container Storage Modules |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: "CSM Modules" | ||
| linkTitle: "CSM Modules" | ||
| description: Deployment of Dell CSM Modules using RPM | ||
| weight: 1 | ||
| --- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| --- | ||
| title: "Installation" | ||
| linkTitle: "Installation" | ||
| description: Deployment of Dell CSM Modules using RPM | ||
| weight: 1 | ||
| --- |
194 changes: 194 additions & 0 deletions
194
content/docs/deployment/rpm/modules/installation/authorization/authorization.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,194 @@ | ||
| --- | ||
| title: Authorization | ||
| linktitle: Authorization | ||
| description: > | ||
| Dell Technologies (Dell) Container Storage Modules (CSM) for Authorization RPM deployment | ||
| --- | ||
|
|
||
| {{% pageinfo color="primary" %}} | ||
| The CSM Authorization RPM will be deprecated in a future release. It is highly recommended that you use CSM Authorization Helm deployment or CSM Operator going forward. | ||
| {{% /pageinfo %}} | ||
|
|
||
| This section outlines the deployment steps for Container Storage Modules (CSM) for Authorization. The deployment of CSM for Authorization is handled in 2 parts: | ||
| - Deploying the CSM for Authorization proxy server, to be controlled by storage administrators | ||
| - Configuring one to many [supported](../../../../../prerequisites/#supported-csm-modules) Dell CSI drivers with CSM for Authorization | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| The CSM for Authorization proxy server requires a Linux host with the following minimum resource allocations: | ||
| - 32 GB of memory | ||
| - 4 CPU | ||
| - 200 GB local storage | ||
|
|
||
| The following package needs to be installed on the Linux host: | ||
| - container-selinux | ||
|
|
||
| Use the appropriate package manager on the machine to install the package. | ||
|
|
||
| ### Using yum on CentOS/RedHat 7: | ||
|
|
||
| yum install -y container-selinux | ||
|
|
||
| ### Using yum on CentOS/RedHat 8: | ||
|
|
||
| yum install -y container-selinux | ||
|
|
||
| ### Dark Sites | ||
|
|
||
| For environments where `yum` will not work, obtain the supported version of container-selinux for your OS version and install it. | ||
|
|
||
| The container-selinux RPMs for CentOS/RedHat 7 and 8 can be downloaded from [https://centos.pkgs.org/7/centos-extras-x86_64/](https://centos.pkgs.org/7/centos-extras-x86_64/) and [https://centos.pkgs.org/8-stream/centos-appstream-x86_64/](https://centos.pkgs.org/8-stream/centos-appstream-x86_64/), respectively. | ||
|
|
||
| ## Deploying the CSM Authorization Proxy Server | ||
|
|
||
| The first part of deploying CSM for Authorization is installing the proxy server. This activity and the administration of the proxy server will be owned by the storage administrator. | ||
|
|
||
| The CSM for Authorization proxy server is installed using a shell script after extracting from a tar archive. | ||
|
|
||
| If CSM for Authorization is being installed on a system where SELinux is enabled, you must ensure the proper SELinux policies have been installed. | ||
|
|
||
| ### Shell Script Installer | ||
|
|
||
| The easiest way to obtain the tar archive with the shell script installer is directly from the [GitHub repository's releases](https://github.com/dell/karavi-authorization/releases) section. | ||
|
|
||
| Alternatively, the tar archive can be built from source by cloning the [GitHub repository](https://github.com/dell/karavi-authorization) and using the following Makefile targets to build the installer: | ||
|
|
||
| ```bash | ||
| make dist build-installer rpm package | ||
| ``` | ||
|
|
||
| The `build-installer` step creates a binary at `karavi-authorization/bin/deploy` and embeds all components required for installation. The `rpm` step generates an RPM package and stores it at `karavi-authorization/deploy/rpm/x86_64/`. The `package` step bundles the install script, authorization package, pre-downloaded K3s-SELinux packages, and policies folder together for the installation in the `packages/` directory. | ||
| This allows CSM for Authorization to be installed in network-restricted environments. | ||
|
|
||
| A Storage Administrator can execute the shell script, install_karavi_auth.sh as a root user or via `sudo`. | ||
|
|
||
| ### Installing the RPM | ||
|
|
||
| 1. Before installing the rpm, some network and security configuration inputs need to be provided in json format. The json file should be created in the location `$HOME/.karavi/config.json` having the following contents: | ||
|
|
||
| ```json | ||
| { | ||
| "web": { | ||
| "jwtsigningsecret": "secret" | ||
| }, | ||
| "proxy": { | ||
| "host": ":8080" | ||
| }, | ||
| "zipkin": { | ||
| "collectoruri": "http://zipkin-addr:9411/api/v2/spans", | ||
| "probability": 1 | ||
| }, | ||
| "certificate": { | ||
| "keyFile": "path_to_private_key_file", | ||
| "crtFile": "path_to_host_cert_file", | ||
| "rootCertificate": "path_to_root_CA_file" | ||
| }, | ||
| "hostname": "DNS-hostname" | ||
| } | ||
| ``` | ||
|
|
||
| In an instance where a secure deployment is not required, an insecure deployment is possible. Please note that self-signed certificates will be created for you using cert-manager to allow TLS encryption for communication on the CSM for Authorization proxy server. However, this is not recommended for production environments. For an insecure deployment, the json file in the location `$HOME/.karavi/config.json` only requires the following contents: | ||
|
|
||
| ```json | ||
| { | ||
| "hostname": "DNS-hostname" | ||
| } | ||
| ``` | ||
|
|
||
| >__Note__: | ||
| > - `DNS-hostname` refers to the hostname of the system in which the CSM for Authorization server will be installed. This hostname can be found by running `nslookup <IP_address>` | ||
| > - There are a number of ways to create certificates. In a production environment, certificates are usually created and managed by an IT administrator. Otherwise, certificates can be created using OpenSSL. | ||
| 3. To install the rpm package on the system, you must first extract the contents of the tar file with the command: | ||
|
|
||
| ```shell | ||
| tar -xvf karavi_authorization_<version> | ||
| ``` | ||
|
|
||
| 4. Afterwards, you must enter the extracted folder's directory and run the shell script: | ||
|
|
||
| ```shell | ||
| cd karavi_authorization_<version> | ||
| sh install_karavi_auth.sh | ||
| ``` | ||
|
|
||
| As an option, on version 1.6.0, the Nodeports for the ingress controller can be specified: | ||
| ```bash | ||
|
|
||
| sh install_karavi_auth.sh --traefik_web_port <web port number> --traefik_websecure_port <websecure port number> | ||
| ```` | ||
| Ex.: | ||
| ```bash | ||
| sh install_karavi_auth.sh --traefik_web_port 30001 --traefik_websecure_port 30002 | ||
| ``` | ||
|
|
||
| 5. After installation, application data will be stored on the system under `/var/lib/rancher/k3s/storage/`. | ||
|
|
||
| If errors occur during installation, review the [Troubleshooting](../../../../../authorization/troubleshooting) section. | ||
|
|
||
| ## Configuring the CSM for Authorization Proxy Server | ||
|
|
||
| The first part of CSM for Authorization deployment is to configure the proxy server. This is controlled by the Storage Administrator. | ||
|
|
||
| Please follow the steps outlined in the [proxy server](../../../../../authorization/configuration/proxy-server) configuration. | ||
|
|
||
| ## Configuring a Dell CSI Driver with CSM for Authorization | ||
|
|
||
| The second part of CSM for Authorization deployment is to configure one or more of the [supported](../../../../../prerequisites/#supported-csm-modules) CSI drivers. This is controlled by the Kubernetes tenant administrator. | ||
|
|
||
| Please follow the steps outlined in [PowerFlex](../../../../../authorization/configuration/powerflex), [PowerMax](../../../../../authorization/configuration/powermax), or [PowerScale](../../../../../authorization/configuration/powerscale) to configure the CSI Driver to work with the Authorization sidecar. | ||
|
|
||
| ## Updating CSM for Authorization Proxy Server Configuration | ||
|
|
||
| CSM for Authorization has a subset of configuration parameters that can be updated dynamically: | ||
|
|
||
| | Parameter | Type | Default | Description | | ||
| | -------------------- | ------ | -------- | ---------------------------------- | | ||
| | web.jwtsigningsecret | String | "secret" | The secret used to sign JWT tokens | | ||
|
|
||
| Updating configuration parameters can be done by editing the `karavi-config-secret` on the CSM for the Authorization Server. The secret can be queried using k3s and kubectl like so: | ||
|
|
||
| ```bash | ||
| k3s kubectl -n karavi get secret/karavi-config-secret | ||
| ``` | ||
|
|
||
| To update or add parameters, you must edit the base64 encoded data in the secret. The` karavi-config-secret` data can be decoded like so: | ||
|
|
||
| ```bash | ||
| k3s kubectl -n karavi get secret/karavi-config-secret -o yaml | grep config.yaml | head -n 1 | awk '{print $2}' | base64 -d | ||
| ``` | ||
|
|
||
| Save the output to a file or copy it to an editor to make changes. Once you are done with the changes, you must encode the data to base64. If your changes are in a file, you can encode it like so: | ||
|
|
||
| ```bash | ||
| cat <file> | base64 | ||
| ``` | ||
|
|
||
| Copy the new, encoded data and edit the `karavi-config-secret` with the new data. Run this command to edit the secret: | ||
|
|
||
| ```bash | ||
| k3s kubectl -n karavi edit secret/karavi-config-secret | ||
| ``` | ||
|
|
||
| Replace the data in `config.yaml` under the `data` field with your new, encoded data. Save the changes and CSM for Authorization will read the changed secret. | ||
|
|
||
| >__Note__: If you are updating the signing secret, the tenants need to be updated with new tokens via the `karavictl generate token` command like so. The `--insecure` flag is required if certificates were not provided in `$HOME/.karavi/config.json` | ||
| ```bash | ||
| karavictl generate token --tenant $TenantName --insecure --addr DNS-hostname | sed -e 's/"Token": //' -e 's/[{}"]//g' -e 's/\\n/\n/g' | kubectl -n $namespace apply -f - | ||
| ``` | ||
|
|
||
| ## CSM for Authorization Proxy Server Dynamic Configuration Settings | ||
|
|
||
| Some settings are not stored in the `karavi-config-secret` but in the csm-config-params ConfigMap, such as LOG_LEVEL and LOG_FORMAT. To update the CSM for Authorization logging settings during runtime, run the below command on the K3s cluster, make your changes, and save the updated configmap data. | ||
|
|
||
| ```bash | ||
| k3s kubectl -n karavi edit configmap/csm-config-params | ||
| ``` | ||
|
|
||
| This edit will not update the logging level for the sidecar-proxy containers running in the CSI Driver pods. To update the sidecar-proxy logging levels, you must update the associated CSI Driver ConfigMap in a similar fashion: | ||
|
|
||
| ```bash | ||
| kubectl -n [CSM_CSI_DRVIER_NAMESPACE] edit configmap/<release_name>-config-params | ||
| ``` | ||
|
|
||
| Using PowerFlex as an example, `kubectl -n vxflexos edit configmap/vxflexos-config-params` can be used to update the logging level of the sidecar-proxy and the driver. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| --- | ||
| title: "Uninstallation" | ||
| linkTitle: "Uninstallation" | ||
| description: Uninstallation of Dell CSM Modules using RPM | ||
| weight: 1 | ||
| --- | ||
|
|
Oops, something went wrong.