Skip to content

Commit

Permalink
Adding bootstrap password instructions, tied to nvshas-8773 and 5.4 n…
Browse files Browse the repository at this point in the history
…ew feature usage.

Signed-off-by: Sunil Singh <[email protected]>
  • Loading branch information
sunilarjun committed Jan 10, 2025
1 parent 5369d09 commit 824e874
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
23 changes: 23 additions & 0 deletions docs/03.configuration/01.console/01.console.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,29 @@ All operations in NeuVector can be invoked through the REST API instead of the c

After successful login, the admin user should update the account with a more secure password.

### Setting Up the Bootstrap Password

An admin user can set up a bootstrap password while deploying for the first time. The admin user can change the password after first login using the example code below:

:::important
The bootstrap password needs to follow the format:
- 8 character(s) minimum.
- 1 uppercase character(s).
- 1 lowercase character(s).
- 1 number(s).
:::

```shell
helm install -n neuvector ./ neuvector --set tag=5.4.0,bootstrapPassword=P@ssw0rd1234
```

If it is a fresh install and not a restore from a PVC, and no admin password is set in the configmap or secret then use the below command to retrieve the password to login to the NeuVector WebUI using an admin account. The password is randomly generated during the deployment if AWS cloud billing is enabled.

```shell
kubectl get secret --namespace {{ .Release.Namespace }} neuvector-bootstrap-secret -o
go-template='{{ "{{" }}.data.bootstrapPassword|base64decode{{ "}}" }}{{ "{{" }} "\n" {{ "}}" }}'
```

### Creating Additional Users
New users can be added from the Settings -> Users & Roles menu. There are predefined global roles in NeuVector:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,29 @@ All operations in NeuVector can be invoked through the REST API instead of the c

After successful login, the admin user should update the account with a more secure password.

### Setting Up the Bootstrap Password

An admin user can set up a bootstrap password while deploying for the first time. The admin user can change the password after first login using the example code below:

:::important
The bootstrap password needs to follow the format:
- 8 character(s) minimum.
- 1 uppercase character(s).
- 1 lowercase character(s).
- 1 number(s).
:::

```shell
helm install -n neuvector ./ neuvector --set tag=5.4.0,bootstrapPassword=P@ssw0rd1234
```

If it is a fresh install and not a restore from a PVC, and no admin password is set in the configmap or secret then use the below command to retrieve the password to login to the NeuVector WebUI using an admin account. The password is randomly generated during the deployment if AWS cloud billing is enabled.

```shell
kubectl get secret --namespace {{ .Release.Namespace }} neuvector-bootstrap-secret -o
go-template='{{ "{{" }}.data.bootstrapPassword|base64decode{{ "}}" }}{{ "{{" }} "\n" {{ "}}" }}'
```

### Creating Additional Users
New users can be added from the Settings -> Users & Roles menu. There are predefined global roles in NeuVector:

Expand Down

0 comments on commit 824e874

Please sign in to comment.