# Convenciones de nomenclatura de runbooks

## Nombres de archivo en GitHub

Esperamos una cierta estructura de archivo y nomenclatura en el [repositorio compartido de runbooks](https://github.com/realmjoin/realmjoin-runbooks). RealmJoin importará estas carpetas y archivos desde GitHub a la cuenta de Azure Automation del cliente.

Los guiones ("-") se convertirán en espacios. Las carpetas se usan para separar los runbooks en "contexto" y "categoría", por ejemplo, `user\general`. Los nombres de archivo deben describir el propósito del script. 

Todos los runbooks importados tienen un prefijo de `prefijo rjgit-`, seguido del contexto, ya sea `org`, `grupo`, `usuario` luego la categoría, por ejemplo `_general_`, `_security_`, `_mail_` y el nombre del propio script, como `add-additional-alias`.

### Ejemplo:

Un runbook en GitHub en `user\general` llamado `add-additional-alias.ps1` se mostrará como:

* `rjgit-user_general_add-additional-alias` en la cuenta de Azure Automation 
* "Add Additional Alias" en el Portal de RealmJoin sobre un objeto de usuario en la categoría de runbook "General".

Categorías comunes

* General
* Seguridad
* Correo
* Información del usuario

Puedes definir categorías adicionales, pero no contextos.

### ¿Cuál es el propósito de esto?

Esto permite completar y asignar nombres automáticamente a los runbooks en el Portal de RealmJoin. Además, el `prefijo rjgit-` prefijo permite evitar conflictos de nomenclatura con runbooks locales o del cliente. Los runbooks que no tengan este prefijo no serán afectados por la lógica de importación de RealmJoin.

## Runbooks privados / específicos del cliente

Puedes alojar runbooks privados (locales) en tu cuenta de Azure Automation. Estos runbooks aparecerán en el Portal de RealmJoin igual que los runbooks compartidos. Los runbooks locales no serán afectados por nuestro proceso de sincronización y no serán visibles para otros clientes.

Para crear un runbook local, elimina el `prefijo rjgit-` prefijo de la convención de nomenclatura, manteniendo intacta el resto de la estructura de nombres.

Ejemplo: quieres ofrecer un runbook "Private Runbook" en el contexto de grupos de Azure AD y la categoría "General". Lo nombrarías `group_general_private-runbook` en tu cuenta de Azure Automation.

Esto se verá así en Azure Automation:

![Nombres de runbooks en GitHub / Azure Automation](https://3832142177-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2Fdv7DajK5q1sVfnlQKurb%2Fnaming-ing1.png?alt=media\&token=136ada07-f577-4210-bd23-4cae6e83fce0)

Se presentará en el Portal de RealmJoin como:

![Nombres de runbooks en el Portal de RealmJoin](https://3832142177-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MkrcM7cKOpXKri1kVrh%2Fuploads%2FwGCdu4ikL2Qvubpf3K2a%2Fnaming-ing2.png?alt=media\&token=917652eb-4cec-4607-8165-f62356477c87)