Skip to content

Commit

Permalink
Documentation updates
Browse files Browse the repository at this point in the history
  • Loading branch information
LewisKSaint authored Jun 7, 2023
1 parent 181acb9 commit b10b834
Show file tree
Hide file tree
Showing 2 changed files with 55 additions and 1 deletion.
54 changes: 54 additions & 0 deletions docs/PubSubPlusK8SDeployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ Contents:
+ [Security considerations](#security-considerations)
- [Using Security Context](#using-security-context)
- [Enabling pod label "active" in a tight security environment](#enabling-pod-label-active-in-a-tight-security-environment)
+ [User management considerations](#user-management-considerations)
- [Adding new users](#adding-new-users)
- [Changing user passwords](#changing-user-passwords)
* [**Deployment Prerequisites**](#deployment-prerequisites)
+ [Platform and tools setup](#platform-and-tools-setup)
- [Install the `kubectl` command-line tool](#install-the-kubectl-command-line-tool)
Expand Down Expand Up @@ -596,6 +599,57 @@ Services require [pod label "active"](#using-pod-label-active-to-identify-the-ac

Using secrets for TLS server keys and certificates follows Kubernetes recommendations, however, particularly in a production environment, additional steps are required to ensure only authorized access to these secrets following Kubernetes industry best practices, including setting tight RBAC permissions and fixing possible security holes.

### User management considerations

#### Adding new users

The deployment comes with an existing user `admin`. Depending on how the installation is carried out, it should start with a random
password or an existing one. Refer [here](#admin-password). The default `admin` user has `admin` CLI User Access Level. This means
an `admin` user can execute all CLI commands on the event broker which also includes controlling broker-wide authentication and authorization. They can also create other admin users.

However, if there is need to set up a new CLI user, first directly access the event broker pod:

```sh
kubectl exec -it XXX-XXX-pubsubplus-<pod-ordinal> -- bash
```

once you have access to the Solace CLI, enter the following commands to create a new user:

```sh
solace> enable
solace# configure
solace(configure)# create username <new-user-name>
```

enter the following commands to set the CLI User and their access level. For a full list of all the available access levels refer to [this](https://docs.solace.com/Admin/CLI-User-Access-Levels.htm)

```sh
solace(configure/username) global-access-level <access-level>
solace(configure/username) change-password <password>
```

The new user will now be available for use via the CLI

#### Changing user passwords

At the moment, we do not support changing the default `admin` user password.
If there is a need to change the password of a user other than the `admin`.

Directly access the event broker pod:

```sh
kubectl exec -it XXX-XXX-pubsubplus-<pod-ordinal> -- bash
```

get access to the Solace CLI and enter the following commands:

```sh
solace> enable
solace# configure
solace(configure)# username <user-name>
solace(configure/username) change-password <password>
```

## Deployment Prerequisites

### Platform and tools setup
Expand Down
2 changes: 1 addition & 1 deletion pubsubplus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ For more ways to override default chart values, refer to [Customizing the Helm C
| `solace.podModifierEnabled` | Enables modifying (reducing) CPU and memory resources for Monitoring nodes in an HA deployment. Also requires the ["solace-pod-modifier" Kubernetes admission plugin](https://github.com/SolaceProducts/pubsubplus-kubernetes-helm-quickstart/blob/master/solace-pod-modifier-admission-plugin/README.md#how-to-use) deployed to work. | Undefined, meaning not enabled. |
| `solace.usernameAdminPassword` | The password for the "admin" management user. Will autogenerate it if not provided. **Important:** refer to the the information from `helm status` how to retrieve it and use it for `helm upgrade`. | Undefined, meaning autogenerate |
| `solace.timezone` | Timezone setting for the PubSub+ container. Valid values are tz database time zone names. | Undefined, default is UTC |
| `solace.extraEnvVars` | List of extra environment variables to be added to the PubSub+ container. A primary use case is to specify [configuration keys](https://docs.solace.com/Configuring-and-Managing/SW-Broker-Specific-Config/Docker-Tasks/Config-SW-Broker-Container-Cfg-Keys.htm). Important: env variables defined here will not override the ones defined in solaceConfigMap. | Undefined |
| `solace.extraEnvVars` | List of extra environment variables to be added to the PubSub+ container. A primary use case is to specify [configuration keys](https://docs.solace.com/Software-Broker/Configuration-Keys-Reference.htm). Important: env variables defined here will not override the ones defined in solaceConfigMap. | Undefined |
| `solace.extraEnvVarsCM` | The name of an existing ConfigMap containing extra environment variables | Undefined |
| `solace.extraEnvVarsSecret` | The name of an existing Secret containing extra environment variables (in case of sensitive data) | Undefined |
| `image.repository` | The image repo name and path to the PubSub+ container image | `solace/solace-pubsub-standard` |
Expand Down

0 comments on commit b10b834

Please sign in to comment.