Skip to content

Commit

Permalink
PS-9629 [DOCS] - Review Simple LDAP documentation variables 8.0
Browse files Browse the repository at this point in the history 
	modified:   docs/ldap-authentication.md
	new file:   docs/ldap-simple-variables.md
  • Loading branch information
@patrickbirch
patrickbirch committed Jan 13, 2025
1 parent 0d7e07d commit 04eb3f3
Show file tree
Hide file tree
Showing 3 changed files with 114 additions and 8 deletions.
8 changes: 0 additions & 8 deletions docs/ldap-authentication.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -114,12 +114,6 @@ Install the plugin with the following statements.
mysql> INSTALL PLUGIN authentication_ldap_simple SONAME 'authentication_ldap_simple.so';
```

To set and persist values at runtime, use the following statements:

```{.bash data-prompt="mysql>"}
mysql> SET PERSIST authentication_ldap_simple_server_host='127.0.0.1';
mysql> SET PERSIST authentication_ldap_simple_bind_base_dn='dc=percona, dc=com';
```

=== "Load the SASL-based LDAP authentication plugin"

Expand Down Expand Up @@ -271,8 +265,6 @@ If you installed either plugin at [server startup](#load-the-plugins-at-server-s
mysql> UNINSTALL PLUGIN authentication_ldap_simple;
```

If you used `SET_PERSIST`, use `RESET PERSIST` to remove the settings.

=== "Uninstall the SASL-based LDAP authentication plugin"

If you installed the plugins at [runtime](#load-the-sasl-based-ldap-authentication-plugin-at-runtime), run the following statements:
Expand Down
113 changes: 113 additions & 0 deletions docs/ldap-simple-variables.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,113 @@
# Simple LDAP system variables

The following variables are static. These variables can only be modified by restarting the server with a new value set in the configuration file (for example, my.cnf or my.ini) or passed as a command-line option when starting the server.

| **Name** | **Command Line** | **Dynamic** | **Scope** |
|--------------------------------------------|------------------|-------------|-----------|
| `authentication_ldap_simple_bind_root_dn` | Yes | No | Global |
| `authentication_ldap_simple_bind_root_pwd` | Yes | No | Global |
| `authentication_ldap_simple_ca_path` | Yes | No | Global |
| `authentication_ldap_simple_server_host` | Yes | No | Global |
| `authentication_ldap_simple_server_port` | Yes | No | Global |
| `authentication_ldap_simple_ssl` | Yes | No | Global |
| `authentication_ldap_simple_tls` | Yes | No | Global |

### `authentication_ldap_simple_bind_root_dn`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-bind-root-dn=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

The `root` credential used to authenticate against an LDAP. This variable is used with `authentication_ldap_simple_bind_root_pwd`.

---

### `authentication_ldap_simple_bind_root_pwd`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-bind-root-pwd=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

The `root` password used to authenticate against an LDAP. This variable is used with `authentication_ldap_simple_bind_root_dn`.

---

### `authentication_ldap_simple_ca_path`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-ca_path=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

The certificate authority's absolute path used to verify the LDAP certificate.

---

### `authentication_ldap_simple_server_host`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-server-host=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

The LDAP server host used for LDAP authentication.

---

### `authentication_ldap_simple_server_port`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-server-port=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

The LDAP server TCP/IP port number used for LDAP authentication.

---

### `authentication_ldap_simple_ssl`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-ssl=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

If this variable is enabled, the plugin connects to the server with SSL.

---

### `authentication_ldap_simple_tls`

| **Option** | **Description** |
|---------------------|-------------------------------------------------|
| Command-line | `--authentication-ldap-simple-tls=value` |
| Scope | Global |
| Dynamic | No |
| Data type | String |
| Default | Null |

If this variable is enabled, the plugin connects to the server with TLS.

---

For more details, see the [LDAP Authentication documentation](ldap-authentication.md).
1 change: 1 addition & 0 deletions mkdocs-base.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -296,6 +296,7 @@ nav:
- LDAP features:
- ldap-authentication.md
- ldap-system-variables.md
- ldap-simple-variables.md
- Data masking:
- data-masking-overview.md
- data-masking-comparison.md
Expand Down

0 comments on commit 04eb3f3

Please sign in to comment.