Skip to content

Commit

Permalink
doc: Update README.md files
Browse files Browse the repository at this point in the history
  • Loading branch information
cdalvaro committed Oct 30, 2024
1 parent c2c4174 commit 61c374d
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,7 +381,7 @@ auth.ldap.groupclass: "person" # The object class to look at when checking group
auth.ldap.groupattribute: "memberOf" # The attribute in that object to look at when checking group membership
```

Finally (since `v3006`) you will need to enable one or more client interfaces:
Finally (since `v3006`) [you will need to enable](https://docs.saltproject.io/en/latest/topics/netapi/netapi-enable-clients.html) one or more client interfaces:

```yml
netapi_enable_clients:
Expand Down
41 changes: 39 additions & 2 deletions docs/es-ES/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -306,15 +306,19 @@ docker run --name salt_master --detach \

Si eliges usar el archivo [compose.yml](/compose.yml) para gestionar tu instancia `salt-master`, descomenta la configuración de `salt-api` para habilitar y configurar el servicio.

Por defecto, se crea el usuario `salt_api` para este servicio, y puedes establecer su contraseña estableciendo la variable de entorno `SALT_API_USER_PASS`. Pero también puedes cambiar el _username_ de `salt-api` estableciendo `SALT_API_USER`.
Por defecto, se crea el usuario `salt_api` para este servicio, y puedes establecer su contraseña estableciendo la variable de entorno `SALT_API_USER_PASS`. También puedes cambiar el _username_ de `salt-api` estableciendo `SALT_API_USER`.

Sin embargo, es posible deshabilitar este usuario estableciendo explícitamente esta variable a una cadena vacía: `SALT_API_USER=''` si vas a usar un servidor `LDAP`, por ejemplo.

Como medida de seguridad, si `SALT_API_ENABLED` se establece a `True` y no deshabilitas `SALT_API_USER`, se requerirá establecer la variable `SALT_API_USER_PASS`. De lo contrario, el proceso de configuración fallará y tu contenedor no arrancará.

También se da la opción de establecer la variable de entorno `SALT_API_USER_PASS_FILE` para proporcionar la contraseña a través de un archivo. Esto es útil cuando se usan _secrets_ de Docker. Más información sobre cómo configurar secretos está disponible en la sección [_Trabajando con secrets_](#trabajando-con-secrets).

Con todo esto configurado, podrás proporcionar tu propia configuración personalizada para `salt-api` creando el archivo `salt-api.conf` dentro de tu directorio `config`:
Con todo esto configurado, podrás proporcionar tu propia configuración personalizada para `salt-api` creando el archivo `salt-api.conf` dentro de tu directorio `config`.

#### Autencicación Externa

Este es un ejemplo de configuración de `salt-api` para autenticar usuarios externos via `pam`:

```yml
external_auth:
Expand All @@ -326,6 +330,39 @@ external_auth:
- "@jobs"
```

También puedes añadir diferentes tipos de atutenticación, como `ldap` o `mysql`. O añadir grupos específicos de usuarios a diferentes roles, indicando el nombre del grupo seguido de `%`. Por ejemplo, para autenticar a los usuarios `admins`:

```yml
external_auth:
ldap:
admins%:
- .*
- "@runner"
- "@wheel"
- "@jobs"
```

#### Configuración LDAP

Para autenticar usuarios via LDAP hay que configurar el acceso al servidor LDAP. El siguiente ejemplo muestra cómo autenticar inicios de sesión a la API de Salt con un servidor LDAP. Luego, define la configuración de grupos para búsquedas de `external_auth` (buscando los usuarios que pertenecen al grupo habilitado vía `memberOf`):

```yml
auth.ldap.uri: ldaps://server.example.com # URI del servidor LDAP
auth.ldap.basedn: "dc=server,dc=example,dc=com" # Búsqueda base DN
auth.ldap.binddn: "uid={{ username }},dc=server,dc=exam,ple,dc=com" # El DN para autenticarse (el nombre de usuario se sustitye con la información de autenticación de la API)
auth.ldap.accountattributename: "uid" # El tipo de atributo de la cuenta de usuario
auth.ldap.groupou: "" # Si no hay grupo, debe establecerse a vacío
auth.ldap.groupclass: "person" # La clase objeto a buscar cuando se comprueba la pertenencia al grupo
auth.ldap.groupattribute: "memberOf" # El atributo del objeto a buscar cuando se comprueba la membresía al grupo
```

Además (desde `v3006`) [es necesario habilitar](https://docs.saltproject.io/en/latest/topics/netapi/netapi-enable-clients.html) una o más interfaces de clientes para permitir la conexión:

```yml
netapi_enable_clients:
- local
```

En el enlace: [External Authentication System (eAuth)](https://docs.saltproject.io/en/latest/topics/eauth/index.html#acl-eauth) hay más información disponible sobre cómo configurar `salt-api` para autenticar usuarios externos.

Ahora tienes tu imagen `docker-salt-master` lista para aceptar autenticaciones externas y conectar herramientas externas como [`saltstack/pepper`](https://github.com/saltstack/pepper).
Expand Down

0 comments on commit 61c374d

Please sign in to comment.