docs: Fix display issue with bullets and code (#3333)
This commit is contained in:
1 parent
401493d225
commit
461427adbc
3 files changed
+27
-27
No files matched your search
@@ -69,14 +69,14 @@ Projects.
|
||||
2. Each role needs to have the user/group added as a principal
|
||||
3. Each role needs to have the grants of
|
||||
|
||||
-   `id=*;type=*;actions=*`
|
||||
- `id=*;type=*;actions=*`
|
||||
|
||||
### Boundary Viewer
|
||||
1. **Each** of the 7 scopes requires a role (ex. “viewer”)
|
||||
2. Each role needs to have the user/group added as a principal
|
||||
3. Each role needs to have the grants of
|
||||
|
||||
-   `id=*;type=*;actions=read,list`
|
||||
- `id=*;type=*;actions=read,list`
|
||||
|
||||
### Org_A admin
|
||||
1. The following scopes **each** require a role (ex. “admin”)
|
||||
@@ -86,22 +86,22 @@ Projects.
|
||||
2. Each role needs to have the user/group added as a principal
|
||||
3. Each role needs to have the grants of
|
||||
|
||||
-   `id=*;type=*;actions=*`
|
||||
- `id=*;type=*;actions=*`
|
||||
|
||||
### Project_1 admin
|
||||
1. Project_1 requires a role (ex. “admin”)
|
||||
2. The role needs to have the user/group added as a principal
|
||||
3. The role needs to have the grants of
|
||||
|
||||
-   `id=*;type=*;actions=*`
|
||||
- `id=*;type=*;actions=*`
|
||||
|
||||
### Project_1 target access
|
||||
1. Project_1 requires a role (ex. “target_access”)
|
||||
2. The role needs to have the user/group added as a principal
|
||||
3. The role needs to have the grants of
|
||||
|
||||
-   `id=*;type=target;actions=list,read,authorize-session`
|
||||
-   `id=*;type=session;actions=read:self,cancel:self,list`
|
||||
- `id=*;type=target;actions=list,read,authorize-session`
|
||||
- `id=*;type=session;actions=read:self,cancel:self,list`
|
||||
|
||||
<Tip>
|
||||
You can use the same roles across “Boundary Admin”, “Org_A Admin”, and “Project_1 Admin” since the scopes and grants are the same. The only difference is
|
||||
|
||||
@@ -18,10 +18,10 @@ To use TLS, you must have two files on each Boundary controller node.
|
||||
You may have to create a new directory to store the certificate material at `/etc/boundary.d/tls`.
|
||||
Place the files in the following paths:
|
||||
|
||||
-   `/etc/boundary.d/tls/boundary-cert.pem`
|
||||
- `/etc/boundary.d/tls/boundary-cert.pem`
|
||||
|
||||
In this path, place the Boundary TLS certificate with a Common Name (CN) and Subject Alternate Name (SAN) that matches your planned primary DNS record for accessing the Boundary controllers and any additional SANs as necessary.
|
||||
-   `/etc/boundary.d/tls/boundary-key.pem`
|
||||
- `/etc/boundary.d/tls/boundary-key.pem`
|
||||
|
||||
In this path, place the Boundary TLS certificate's private key.
|
||||
|
||||
@@ -80,17 +80,17 @@ You must complete the following controller configuration for each of the Boundar
|
||||
|
||||
The core required values for a Boundary controller configuration include the following:
|
||||
|
||||
-   `listener` blocks for `api`, `cluster`, and `ops`
|
||||
- `listener` blocks for `api`, `cluster`, and `ops`
|
||||
- A `kms` block
|
||||
-   `disable_mlock`
|
||||
- `disable_mlock`
|
||||
- A `controller` block
|
||||
|
||||
When you install Boundary from the HashiCorp Linux Repository, it installs some example configuration files under `/etc/boundary.d/`.
|
||||
Run the following commands to rename the example configuration files:
|
||||
|
||||
1.   `sudo mv boundary.hcl boundary.hcl.old`
|
||||
1.   `sudo mv controller.hcl controller.hcl.old`
|
||||
1.   `sudo mv worker.hcl worker.hcl.old`
|
||||
1. `sudo mv boundary.hcl boundary.hcl.old`
|
||||
1. `sudo mv controller.hcl controller.hcl.old`
|
||||
1. `sudo mv worker.hcl worker.hcl.old`
|
||||
|
||||
We recommend that you use either the `env://` or `file://` notation in the configuration files to securely provide secret configuration components to the Boundary controller binaries.
|
||||
In the following controller configuration example, we use `env://` to declare the PostgreSQL connection string, as well as secure the AWS KMS configuration items.
|
||||
@@ -248,7 +248,7 @@ kms "awskms" {
|
||||
|
||||
Refer to the list below for explanations of the parameters used in the example above:
|
||||
|
||||
-  `disable mlcok (bool: false)` - Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to the disk.
|
||||
- `disable mlcok (bool: false)` - Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to the disk.
|
||||
This is fine for local development and testing.
|
||||
However, it is not recommended for production unless the systems running Boundary use only encrypted swap or do not use swap at all.
|
||||
Boundary only supports memory locking on UNIX-like systems that support `mlock()` syscall like Linux and FreeBSD.
|
||||
@@ -261,15 +261,15 @@ Boundary only supports memory locking on UNIX-like systems that support `mlock()
|
||||
|
||||
`LimitMEMLOCK=infinity`
|
||||
|
||||
-   `listener` - Configures the listeners on which Boundary serves traffic (API cluster and proxy).
|
||||
-   `controller` - Configures the controller.
|
||||
- `listener` - Configures the listeners on which Boundary serves traffic (API cluster and proxy).
|
||||
- `controller` - Configures the controller.
|
||||
If present, `boundary server` starts a controller subprocess.
|
||||
-   `events` - Configures event-specific parameters.
|
||||
- `events` - Configures event-specific parameters.
|
||||
|
||||
The example events configuration above is exhaustive and writes all events to both `stderr` and a file.
|
||||
This configuration may or may not work for your organization's logging solution.
|
||||
|
||||
-   `kms` - Configures KMS blocks for [various purposes](/boundary/docs/concepts/security/data-encryption).
|
||||
- `kms` - Configures KMS blocks for [various purposes](/boundary/docs/concepts/security/data-encryption).
|
||||
|
||||
Refer to the links below for configuration information for the different cloud KMS blocks:
|
||||
|
||||
@@ -312,8 +312,8 @@ boundary database init -h
|
||||
When the configuration files are in place on each Boundary controller, you can proceed to enable and start the binary on each of the Boundary controller nodes using `systemd`.
|
||||
Run the following commands to start the service:
|
||||
|
||||
1.  `sudo systemctl enable boundary`
|
||||
1.  `sudo systemctl start boundary`
|
||||
1. `sudo systemctl enable boundary`
|
||||
1. `sudo systemctl start boundary`
|
||||
|
||||
## Authenticate and manage resources
|
||||
|
||||
|
||||
@@ -271,7 +271,7 @@ kms "awskms" {
|
||||
|
||||
Refer to the list below for explanations of the parameters used in the example above:
|
||||
|
||||
-  `disable mlcok (bool: false)` - Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to the disk.
|
||||
- `disable mlcok (bool: false)` - Disables the server from executing the `mlock` syscall, which prevents memory from being swapped to the disk.
|
||||
This is fine for local development and testing.
|
||||
However, it is not recommended for production unless the systems running Boundary use only encrypted swap or do not use swap at all.
|
||||
Boundary only supports memory locking on UNIX-like systems that support `mlock()` syscall like Linux and FreeBSD.
|
||||
@@ -284,15 +284,15 @@ Boundary only supports memory locking on UNIX-like systems that support `mlock()
|
||||
|
||||
`LimitMEMLOCK=infinity`
|
||||
|
||||
-   `listener` - Configures the listeners on which Boundary serves traffic (API cluster and proxy).
|
||||
-   `controller` - Configures the controller.
|
||||
- `listener` - Configures the listeners on which Boundary serves traffic (API cluster and proxy).
|
||||
- `controller` - Configures the controller.
|
||||
If present, `boundary server` starts a controller subprocess.
|
||||
-   `events` - Configures event-specific parameters.
|
||||
- `events` - Configures event-specific parameters.
|
||||
|
||||
The example events configuration above is exhaustive and writes all events to both `stderr` and a file.
|
||||
This configuration may or may not work for your organization's logging solution.
|
||||
|
||||
-   `kms` - Configures KMS blocks for [various purposes](/boundary/docs/concepts/security/data-encryption).
|
||||
- `kms` - Configures KMS blocks for [various purposes](/boundary/docs/concepts/security/data-encryption).
|
||||
|
||||
Refer to the links below for configuration information for the different cloud KMS blocks:
|
||||
|
||||
@@ -310,8 +310,8 @@ Refer to the documentation for additional [top-level configuration options](/bou
|
||||
When the configuration files are in place on each Boundary controller, you can proceed to enable and start the binary on each of the Boundary worker nodes using `systemd`.
|
||||
Run the following commands to start the service:
|
||||
|
||||
1.  `sudo systemctl enable boundary`
|
||||
1.  `sudo systemctl start boundary`
|
||||
1. `sudo systemctl enable boundary`
|
||||
1. `sudo systemctl start boundary`
|
||||
|
||||
## Adopt the PKI workers (optional)
|
||||
|
||||
|
||||
Reference in new issue
Block a user