paramsx 2.1.0__tar.gz → 2.2.1__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- paramsx-2.2.1/CHANGELOG.md +123 -0
- {paramsx-2.1.0/paramsx.egg-info → paramsx-2.2.1}/PKG-INFO +148 -62
- {paramsx-2.1.0 → paramsx-2.2.1}/README.md +147 -61
- paramsx-2.2.1/paramsx/__init__.py +1 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx/funcions.py +106 -21
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx/main.py +409 -98
- paramsx-2.2.1/paramsx/paramsx_config.py +108 -0
- {paramsx-2.1.0 → paramsx-2.2.1/paramsx.egg-info}/PKG-INFO +148 -62
- {paramsx-2.1.0 → paramsx-2.2.1}/setup.py +7 -1
- paramsx-2.1.0/CHANGELOG.md +0 -76
- paramsx-2.1.0/paramsx/__init__.py +0 -0
- paramsx-2.1.0/paramsx/paramsx_config.py +0 -45
- {paramsx-2.1.0 → paramsx-2.2.1}/LICENSE +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/MANIFEST.in +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx/text.py +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx.egg-info/SOURCES.txt +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx.egg-info/dependency_links.txt +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx.egg-info/entry_points.txt +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx.egg-info/requires.txt +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/paramsx.egg-info/top_level.txt +0 -0
- {paramsx-2.1.0 → paramsx-2.2.1}/setup.cfg +0 -0
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## 2.2.1
|
|
4
|
+
|
|
5
|
+
Solo comandos de terminal y documentación: no cambia nada de la lectura, la carga ni la
|
|
6
|
+
construcción de rutas. Si ya tienes la 2.2.0 funcionando, actualizar no te obliga a tocar
|
|
7
|
+
tu configuración.
|
|
8
|
+
|
|
9
|
+
### Añadido
|
|
10
|
+
|
|
11
|
+
- **`paramsx --version`** (y `-v`), y la versión también en la cabecera de `paramsx --help`. La versión pasa a vivir en `paramsx/__init__.py` y `setup.py` la lee de ahí, para que el paquete y el comando no puedan decir cosas distintas.
|
|
12
|
+
- **`paramsx configure` sobre una configuración que ya existe ya no se queda en "no se sobrescribirá".** Sigue sin tocar el fichero, pero ahora te dice qué opciones nuevas no tienes y con qué valor por defecto se rellenan, si usas el nombre antiguo `abac`, y si la configuración es válida.
|
|
13
|
+
- **`paramsx configure --ejemplo`**: además de lo anterior, deja la plantilla de esta versión en `~/.xsoft/paramsx_config.ejemplo.py`, al lado de la tuya, para comparar. ParamsX no la lee: es solo referencia. Escribir en tu configuración es lo único que no se puede deshacer, así que va en un comando aparte y en otro fichero.
|
|
14
|
+
- Mensaje de primer arranque más claro cuando todavía no hay configuración, explicando qué hace `paramsx configure` y dónde va el fichero.
|
|
15
|
+
|
|
16
|
+
### Cambiado
|
|
17
|
+
|
|
18
|
+
- **`paramsx --help` al día.** La opción 2 ya explica que eliges entre los ficheros que tengas en el directorio; el ejemplo de `mixto` usa el entorno en mayúscula como el resto de la documentación; `fichero_por_ruta` enseña el nombre real (`parameters_dev__API_STA__max.py`); y se documentan `profile_name`, `region_name` y `entornos`, que no aparecían aunque son obligatorios.
|
|
19
|
+
- **El README muestra el contenido literal de `paramsx_config.py`**, con sus comentarios y tablas, en vez de una versión resumida: es exactamente lo que te crea `paramsx configure`, así que no pueden desincronizarse. Y una tabla con todos los comandos disponibles.
|
|
20
|
+
|
|
21
|
+
## 2.2.0
|
|
22
|
+
|
|
23
|
+
### Añadido
|
|
24
|
+
|
|
25
|
+
- **Perfiles de naming libres.** `min` y `max` dejan de estar cableados en el código: ahora son entradas de un diccionario `naming` en `~/.xsoft/paramsx_config.py` que puedes redefinir, ampliar y renombrar. Cada perfil declara tres cosas:
|
|
26
|
+
- `posicion_entorno`: `inicio` (`/rds` → `/dev/rds`), `final` (`/API/STA` → `/API/STA/DEV`), `mixto` (`/API/*/STA` → `/API/dev/STA`) o `ninguno` (`/api/sta/auth` → `/api/sta/auth`).
|
|
27
|
+
- `case_entorno`: `lower`, `upper` o `capitalize`.
|
|
28
|
+
- `case_ruta`: `lower`, `upper`, `capitalize` o `ninguno`; a qué case se fuerza la ruta al crear un parámetro nuevo. Con `ninguno` se respeta lo que escribas.
|
|
29
|
+
- **Marcador `*` para colocar el entorno donde quieras** (perfiles `mixto`). Sirve para acotar la lectura a un subárbol concreto: `/API/MULTIAPI/*/stan_ai` lee solo `/API/MULTIAPI/DEV/stan_ai` en vez de todo lo que cuelga de `/API/MULTIAPI/DEV`. El `*` debe ser un segmento entero y aparecer exactamente una vez.
|
|
30
|
+
- **`posicion_entorno: "ninguno"`**, para cuentas que separan los entornos por cuenta de AWS y no meten el entorno en la ruta. Antes esas cuentas no podían usar ParamsX: toda ruta recibía un segmento de entorno sí o sí.
|
|
31
|
+
- **`fichero_por_ruta`**: con `True`, el fichero exportado incluye la ruta y el perfil en su nombre (`parameters_dev__API_STA__max.py`), así leer una segunda ruta del mismo entorno no machaca la que estabas editando. Con `False` (por defecto) se mantiene el nombre de siempre. En los dos modos ParamsX **pide confirmación antes de sobrescribir** un fichero de una lectura anterior, porque volver a leer la misma ruta también se lleva por delante lo que tuvieras editado.
|
|
32
|
+
- **La carga (opción 2) lista los ficheros que hay en el directorio**, en vez de pedir ruta y entorno y fallar si no existe el fichero correspondiente. Se ofrecen los que conservan su backup al lado, se lean con `fichero_por_ruta` o sin él, e incluso los de una ruta que ya hayas quitado de tu `parameter_list`.
|
|
33
|
+
- **`convencion_nuevos`**: qué perfil usan los parámetros creados con la opción 4. Si no lo declaras, se usa el primer perfil de `naming`.
|
|
34
|
+
- **Validación de la configuración al arrancar**, para que un naming mal declarado se vea como un error y no como una lista de parámetros vacía: perfil inexistente, `posicion_entorno`/`case_entorno`/`case_ruta` con valores inválidos, perfil `mixto` sin `*`, `*` en un perfil que no es `mixto`, más de un `*`, `*` pegado a un segmento, y aviso si dos entradas resuelven a la misma ruta.
|
|
35
|
+
|
|
36
|
+
### Cambiado
|
|
37
|
+
|
|
38
|
+
- **`abac` pasa a llamarse `tags_activas`.** Es el mismo interruptor de siempre (gestionar y validar tags), con un nombre que dice lo que hace en vez de por qué lo queremos nosotros. **El nombre viejo se sigue aceptando**, así que las configuraciones de la 2.0 y la 2.1 funcionan sin tocar nada.
|
|
39
|
+
- **La opción 4 (crear parámetro) ya no está cableada a `min`.** Antes forzaba toda la ruta a minúscula y exigía que el primer segmento fuera el entorno, así que quien nombra sus parámetros en mayúscula no podía crearlos con la herramienta. Ahora se escribe la ruta **sin el entorno**, igual que en `parameter_list`, y ParamsX aplica el perfil de `convencion_nuevos`, respeta el case según `case_ruta` y enseña la ruta resultante en AWS para confirmarla antes de seguir.
|
|
40
|
+
|
|
41
|
+
### Corregido
|
|
42
|
+
|
|
43
|
+
- **La convención `max` ponía el entorno en el medio de la ruta.** Con rutas de más de un segmento el entorno se insertaba tras el primer segmento (`/API/MULTIAPI` + `dev` → `/API/DEV/MULTIAPI`), cuando en `max` el entorno va **siempre al final**: `/API/MULTIAPI` + `dev` → `/API/MULTIAPI/DEV`. Con esa inserción en medio, ninguna ruta `max` de más de un segmento resolvía a una ruta real, así que no se veían los parámetros. Las rutas de un solo segmento (`/EMAIL` → `/EMAIL/DEV`) no cambian: ahí el resultado ya era correcto.
|
|
44
|
+
- La documentación de la 2.0.0 (README, plantilla de configuración y `paramsx --help`) describía esa inserción en medio como el comportamiento esperado de `max`, con el ejemplo `/API/STA` → `/API/DEV/STA`. Corregida: el ejemplo correcto es `/API/STA` → `/API/STA/DEV`.
|
|
45
|
+
|
|
46
|
+
### Actualizar desde la 2.1.0
|
|
47
|
+
|
|
48
|
+
No hay que tocar nada: sin `naming` en tu fichero se usan los perfiles de la plantilla, donde `min` y `max` significan lo mismo que antes, y `abac` se sigue leyendo como `tags_activas`. Todo lo nuevo (`*`, `ninguno`, `fichero_por_ruta`, `convencion_nuevos`) es opcional. Si quieres usarlo, la forma más rápida de ver la plantilla nueva entera es `paramsx --help` o el README.
|
|
49
|
+
|
|
50
|
+
## 2.1.0
|
|
51
|
+
|
|
52
|
+
### Añadido
|
|
53
|
+
|
|
54
|
+
- **Flag `obligatorias_vacias`** en `~/.xsoft/paramsx_config.py`. Solo tiene efecto con `abac = True`:
|
|
55
|
+
- `False` (valor por defecto, comportamiento de la 2.0.0): validación bloqueante. Si a un parámetro le falta cualquiera de las tags obligatorias no se sube ni su valor ni sus tags, y al crear un parámetro no se puede dejar una tag en blanco.
|
|
56
|
+
- `True`: se permite dejar vacías las tags obligatorias. El parámetro se sube igualmente y **las tags sin valor no se crean en AWS**: nunca se suben etiquetas vacías. En la creación puedes saltar una tag pulsando Enter y el resumen previo lista cuáles quedan vacías.
|
|
57
|
+
- El informe de carga incluye un bloque `Tags obligatorias vacías` con el parámetro y las tags afectadas, para dejar constancia sin bloquear.
|
|
58
|
+
|
|
59
|
+
No hay que tocar nada en la configuración para actualizar desde la 2.0.0: si no defines `obligatorias_vacias`, se asume `False` y todo sigue igual.
|
|
60
|
+
|
|
61
|
+
### Nota
|
|
62
|
+
|
|
63
|
+
Vaciar una tag **que ya tenía valor en AWS** sigue significando borrarla del parámetro, en los dos modos. Es la forma de eliminar una tag. Lo que cambia con `obligatorias_vacias = True` es que una tag en blanco que nunca existió simplemente no se crea, en vez de bloquear la subida.
|
|
64
|
+
|
|
65
|
+
## 2.0.0
|
|
66
|
+
|
|
67
|
+
### ⚠ Breaking change: hay que actualizar `~/.xsoft/paramsx_config.py` a mano
|
|
68
|
+
|
|
69
|
+
`parameter_list` **ya no es una lista de strings**: cada entrada es ahora un diccionario que declara su convención de naming. El formato antiguo no es compatible y ParamsX se niega a arrancar mostrando cómo migrarlo.
|
|
70
|
+
|
|
71
|
+
Antes (1.x):
|
|
72
|
+
|
|
73
|
+
```python
|
|
74
|
+
"entornos": ["DEV", "PROD"],
|
|
75
|
+
"parameter_list": [
|
|
76
|
+
"/params1/xx",
|
|
77
|
+
"/params2/xx",
|
|
78
|
+
]
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Ahora (2.0.0):
|
|
82
|
+
|
|
83
|
+
```python
|
|
84
|
+
"entornos": ['dev', 'pre', 'prod'], # SIEMPRE en minúscula, lista canónica única
|
|
85
|
+
"parameter_list": [
|
|
86
|
+
{"path": "/common", "convencion": "min"},
|
|
87
|
+
{"path": "/rds", "convencion": "min"},
|
|
88
|
+
{"path": "/EMAIL", "convencion": "max"},
|
|
89
|
+
{"path": "/API/STA", "convencion": "max"},
|
|
90
|
+
]
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
Además:
|
|
94
|
+
- `entornos` se escribe **siempre en minúscula**. El entorno en mayúscula de las rutas `max` se deriva con `.upper()` de esa misma lista.
|
|
95
|
+
- Ya **no existe** `entornos_old`.
|
|
96
|
+
- Los ficheros temporales pasan a llamarse `parameters_dev.py` (antes `parameters_DEV.py`) al usar entornos en minúscula.
|
|
97
|
+
|
|
98
|
+
### Añadido
|
|
99
|
+
|
|
100
|
+
- **Doble convención de naming en `parameter_list`.** Cada ruta declara `"convencion": "min"` o `"max"`:
|
|
101
|
+
- `min` (convención nueva): el entorno en minúscula se añade **al principio**. `/rds` + `dev` → `/dev/rds`.
|
|
102
|
+
- `max` (convención legacy): el entorno en mayúscula se inserta **tras el primer segmento**. `/API/STA` + `dev` → `/API/DEV/STA`; `/EMAIL` + `dev` → `/EMAIL/DEV`. (Esto era un bug, corregido en la 2.2.0: el entorno va al final, `/API/STA/DEV`.)
|
|
103
|
+
- **Opción 4 del menú: "Crear nuevo parámetro".** Pide ruta (siempre en convención `min`, forzada a minúscula), valor (texto plano o JSON, validado) y las tags obligatorias. Se crea con `Overwrite=False` para no machacar nada. No se puede crear un parámetro con la convención `max`.
|
|
104
|
+
- **Aviso de correlación de naming en RDS.** Al crear un parámetro de RDS se comprueba que exista su contraparte (`/{entorno}/common/rds/{nombre-servicio}` ↔ `/{entorno}/rds/{nombre-servicio}/...`) y se avisa si falta. Es un aviso, no bloquea.
|
|
105
|
+
- **Flag `abac` y tags obligatorias.** Con `abac = True`, el fichero exportado incluye un campo por tag (`tagApplication`, `tagEnvironment`, `tagOwner`, `tagProject`, `tagProduct`, `tagService`, `tagComponent`, `tagManagedBy`) con su valor actual en AWS. Estas 8 tags sostienen el control de acceso ABAC vía IAM de toda la cuenta. La lista vive en `tags_obligatorias`, en el propio fichero de configuración, para poder ampliarla sin tocar código. Con `abac = False` no aparecen tags en el fichero y no se valida nada (comportamiento 1.x).
|
|
106
|
+
- **Validación bloqueante por parámetro.** Al cargar con `abac = True`, si a un parámetro le falta cualquiera de las tags obligatorias no se sube ni su valor ni sus tags, y se indica qué falta y en qué `parameter_name`. El resto del lote se sube con normalidad. Cuando la carga queda a medias los ficheros no se borran y el backup se resincroniza con lo ya aplicado, así que la segunda pasada solo sube lo pendiente.
|
|
107
|
+
- **Round-trip de tags en la edición.** Los diffs de tags se detectan igual que los de valores (Nuevos / Modificados / Eliminados) y se aplican con `add_tags_to_resource` / `remove_tags_from_resource` en la misma pasada que el valor, sin borrar ni recrear el parámetro. Vaciar el campo de una tag la borra en AWS. Los backups automáticos incluyen las tags.
|
|
108
|
+
|
|
109
|
+
### Cambiado
|
|
110
|
+
|
|
111
|
+
- **Errores de permisos legibles.** `AccessDeniedException` se captura de forma específica y se muestra como `⚠ No tienes permisos para leer: /dev/rds — pídele a un admin que te dé acceso, o acota la ruta en tu parameter_list...`, sin traza de boto3. Cualquier otro error de AWS (ruta inexistente, throttling...) se propaga con su traza normal en lugar de quedar oculto tras un `except Exception`.
|
|
112
|
+
- Los cambios que solo afectan a tags ya no generan una versión nueva del valor del parámetro.
|
|
113
|
+
- Las pantallas de resultado son informes con scroll en vez de un mensaje centrado de 3 segundos.
|
|
114
|
+
- Las tags de sistema (`aws:*`) no se exportan ni se modifican. Las tags existentes que no estén en la lista obligatoria se conservan.
|
|
115
|
+
- `paramsx configure` copia la plantilla que trae el paquete, así que el fichero generado y la documentación no se pueden desincronizar.
|
|
116
|
+
- La configuración se valida antes de entrar en la interfaz curses, con los errores impresos en la terminal.
|
|
117
|
+
- `paramsx --help` documenta las opciones del menú y las claves de configuración.
|
|
118
|
+
|
|
119
|
+
### Corregido
|
|
120
|
+
|
|
121
|
+
- El menú de backup ya no muta `parameter_list` para añadir y quitar sus dos opciones extra.
|
|
122
|
+
- El backup "Total parámetros listados" ya no se interrumpe cuando una ruta no tiene parámetros en algún entorno o no es accesible: continúa con el resto y avisa al final.
|
|
123
|
+
- Los mensajes largos ya no rompen la pantalla: se ajustan al ancho del terminal.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: paramsx
|
|
3
|
-
Version: 2.1
|
|
3
|
+
Version: 2.2.1
|
|
4
4
|
Summary: Librería para gestionar y respaldar parámetros de AWS SSM de manera sencilla y eficiente.
|
|
5
5
|
Home-page: https://github.com/pistatxos/paramsx
|
|
6
6
|
Author: Mariox
|
|
@@ -81,7 +81,8 @@ la ruta en tu parameter_list a algo más específico (ej. /dev/rds/<sub-ruta>).
|
|
|
81
81
|
|
|
82
82
|
2. Comparar y actualizar parámetros
|
|
83
83
|
- Una vez finalizados los ajustes en los parámetros descargados, selecciona esta opción.
|
|
84
|
-
- El programa
|
|
84
|
+
- El programa te muestra **los ficheros que tienes en el directorio** listos para cargar (los que conservan su backup al lado) y eliges cuál. No te pregunta por rutas ni entornos: el fichero ya sabe de dónde salió.
|
|
85
|
+
- Con el elegido hace una comparación detallada, tanto de valores como de tags:
|
|
85
86
|
- Nuevos: Parámetros que serán añadidos.
|
|
86
87
|
- Modificados: Parámetros existentes cuyo valor y/o tags serán actualizados.
|
|
87
88
|
- Eliminados: Parámetros que serán borrados de AWS.
|
|
@@ -96,10 +97,10 @@ Esto te permitirá mantener respaldos seguros o realizar migraciones/reorganizac
|
|
|
96
97
|
|
|
97
98
|
4. Crear nuevo parámetro
|
|
98
99
|
- Crea un parámetro desde cero sin salir de la herramienta. Te pedirá, en este orden:
|
|
99
|
-
- La ruta
|
|
100
|
+
- La ruta **sin el entorno**, igual que la declaras en `parameter_list`: el perfil de naming se encarga de colocarlo. Verás en pantalla la ruta resultante en AWS antes de seguir.
|
|
100
101
|
- El valor: texto plano o JSON en una línea (por ejemplo `{"host": "x", "user": "y", "pass": "z"}`), que se valida antes de continuar.
|
|
101
|
-
- Las tags obligatorias, si tienes `
|
|
102
|
-
-
|
|
102
|
+
- Las tags obligatorias, si tienes `tags_activas = True`.
|
|
103
|
+
- El perfil que se usa es el que declares en `convencion_nuevos`. Si tu perfil es de tipo `mixto`, escribe el `*` en la ruta para indicar dónde va el entorno.
|
|
103
104
|
- Antes de subirlo verás una pantalla de confirmación con la ruta, el valor y las tags. El parámetro se crea con `Overwrite=False`, así que nunca machaca uno existente.
|
|
104
105
|
- Tras crearlo aparecerá la próxima vez que leas la ruta correspondiente de tu `parameter_list`.
|
|
105
106
|
|
|
@@ -127,73 +128,146 @@ Este comando creará automáticamente una carpeta de configuración en tu direct
|
|
|
127
128
|
|
|
128
129
|
Dentro de esta carpeta, encontrarás el archivo paramsx_config.py. Este archivo contiene la configuración inicial que debes ajustar según tu entorno.
|
|
129
130
|
|
|
131
|
+
Si ya tenías configuración de una versión anterior, `paramsx configure` **no la sobrescribe**: te dice qué opciones nuevas no tienes y con qué valor por defecto se están rellenando, y si la configuración es válida. Con `paramsx configure --ejemplo` además deja la plantilla de esta versión en `paramsx_config.ejemplo.py`, al lado de la tuya, para que compares sin tocar nada.
|
|
132
|
+
|
|
130
133
|
Ejemplo del contenido de paramsx_config.py:
|
|
131
134
|
|
|
132
135
|
```python
|
|
133
136
|
## Configuraciones ParamsX
|
|
134
137
|
|
|
138
|
+
# --- Perfiles de naming -------------------------------------------------------------
|
|
139
|
+
# Un perfil dice CÓMO se construye la ruta real en AWS a partir de la ruta que declaras
|
|
140
|
+
# en 'parameter_list' y del entorno que eliges en el menú. Los nombres son tuyos: define
|
|
141
|
+
# solo los que uses y llámalos como quieras. Un perfil tiene tres campos:
|
|
142
|
+
#
|
|
143
|
+
# campo | valores | qué decide
|
|
144
|
+
# ------------------+------------------------------------------+---------------------------
|
|
145
|
+
# posicion_entorno | inicio | final | mixto | ninguno | dónde va el entorno
|
|
146
|
+
# case_entorno | lower | upper | capitalize | cómo se escribe el entorno
|
|
147
|
+
# case_ruta | lower | upper | capitalize | ninguno | case de la ruta AL CREAR
|
|
148
|
+
#
|
|
149
|
+
# posicion_entorno -> dónde se coloca el entorno (ejemplos con el entorno 'dev'):
|
|
150
|
+
#
|
|
151
|
+
# valor | ruta declarada | ruta real en AWS
|
|
152
|
+
# ---------+-----------------+--------------------------------------------------------
|
|
153
|
+
# inicio | /rds | /dev/rds
|
|
154
|
+
# final | /API/STA | /API/STA/DEV
|
|
155
|
+
# mixto | /API/*/STA | /API/DEV/STA el '*' marca el sitio; uno y como segmento
|
|
156
|
+
# ninguno | /api/sta/auth | /api/sta/auth una cuenta AWS por entorno; case_entorno da igual
|
|
157
|
+
#
|
|
158
|
+
# case_entorno -> cómo se escribe ese entorno en la ruta:
|
|
159
|
+
#
|
|
160
|
+
# valor | 'dev' se escribe | ruta real de /API/STA con posicion_entorno=final
|
|
161
|
+
# ------------+------------------+------------------------------------------------
|
|
162
|
+
# lower | dev | /API/STA/dev
|
|
163
|
+
# upper | DEV | /API/STA/DEV
|
|
164
|
+
# capitalize | Dev | /API/STA/Dev
|
|
165
|
+
#
|
|
166
|
+
# case_ruta -> a qué case se fuerza la ruta que TÚ escribes al CREAR un parámetro
|
|
167
|
+
# (opción 4 del menú). No afecta a leer ni a editar: lo que ya existe en AWS se
|
|
168
|
+
# respeta siempre tal cual esté.
|
|
169
|
+
#
|
|
170
|
+
# valor | si escribes /API/MULTIAPI/Token, se crea
|
|
171
|
+
# ------------+-----------------------------------------
|
|
172
|
+
# lower | /api/multiapi/token
|
|
173
|
+
# upper | /API/MULTIAPI/TOKEN
|
|
174
|
+
# capitalize | /Api/Multiapi/Token
|
|
175
|
+
# ninguno | /API/MULTIAPI/Token
|
|
176
|
+
#
|
|
177
|
+
# Combina los tres campos como necesites: no hay una lista cerrada de perfiles. En el
|
|
178
|
+
# README tienes más ejemplos.
|
|
179
|
+
|
|
180
|
+
naming = {
|
|
181
|
+
"min": {"posicion_entorno": "inicio", "case_entorno": "lower", "case_ruta": "lower"},
|
|
182
|
+
"max": {"posicion_entorno": "final", "case_entorno": "upper", "case_ruta": "ninguno"},
|
|
183
|
+
"mixto_max": {"posicion_entorno": "mixto", "case_entorno": "upper", "case_ruta": "ninguno"},
|
|
184
|
+
# Crea los tuyos combinando los valores de la tabla, por ejemplo:
|
|
185
|
+
# "sin_entorno": {"posicion_entorno": "ninguno", "case_entorno": "lower", "case_ruta": "ninguno"},
|
|
186
|
+
}
|
|
187
|
+
|
|
135
188
|
configuraciones = {
|
|
136
189
|
"profile_name": "default", # Cambiar por el nombre de tu perfil en ~/.aws/credentials
|
|
137
190
|
"region_name": "eu-south-2", # Cambiar por tu región de AWS
|
|
138
191
|
"entornos": ['dev', 'pre', 'prod'], # SIEMPRE en minúscula, es la lista canónica única
|
|
139
192
|
"parameter_list": [
|
|
140
|
-
{"path": "/common", "convencion": "min"},
|
|
141
|
-
{"path": "/rds", "convencion": "min"},
|
|
142
|
-
{"path": "/
|
|
143
|
-
{"path": "/
|
|
144
|
-
|
|
193
|
+
{"path": "/common", "convencion": "min"}, # -> /dev/common
|
|
194
|
+
{"path": "/rds", "convencion": "min"}, # -> /dev/rds
|
|
195
|
+
{"path": "/EMAIL", "convencion": "max"}, # -> /EMAIL/DEV
|
|
196
|
+
{"path": "/API/STA", "convencion": "max"}, # -> /API/STA/DEV
|
|
197
|
+
# Con 'mixto' acotas por debajo del entorno: esto lee solo stan_ai, en vez de
|
|
198
|
+
# todo lo que cuelga de /API/MULTIAPI/DEV
|
|
199
|
+
{"path": "/API/MULTIAPI/*/stan_ai", "convencion": "mixto_max"}, # -> /API/MULTIAPI/DEV/stan_ai
|
|
145
200
|
]
|
|
146
201
|
}
|
|
147
202
|
|
|
148
|
-
|
|
149
|
-
|
|
203
|
+
# Perfil de naming que se usa al crear un parámetro nuevo (opción 4 del menú).
|
|
204
|
+
# Si no lo defines, se usa el primer perfil de 'naming'.
|
|
205
|
+
convencion_nuevos = "min"
|
|
206
|
+
|
|
207
|
+
# ¿El nombre del fichero exportado incluye la ruta leída?
|
|
208
|
+
# False -> parameters_dev.py (comportamiento de siempre)
|
|
209
|
+
# True -> parameters_dev__API_STA__max.py (uno por entrada y entorno: lleva el
|
|
210
|
+
# entorno, la ruta y el perfil, porque dos entradas pueden compartir ruta)
|
|
211
|
+
# Ponlo en True si sueles leer varias rutas del mismo entorno y no quieres que la
|
|
212
|
+
# segunda lectura te machaque el fichero de la primera.
|
|
213
|
+
fichero_por_ruta = False
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
## Configuraciones Tags
|
|
217
|
+
|
|
218
|
+
# Gestionar las tags de los parámetros: leerlas de AWS, exponerlas en el fichero
|
|
219
|
+
# exportado para editarlas y validar las obligatorias al cargar.
|
|
220
|
+
# True -> las tags viajan en el fichero y se validan.
|
|
221
|
+
# False -> no aparecen tags en el fichero y no se valida nada.
|
|
222
|
+
# En cuentas cuyo control de acceso va por tags (ABAC vía IAM) esto debe estar en True.
|
|
223
|
+
tags_activas = True
|
|
224
|
+
|
|
225
|
+
# Solo aplica si tags_activas = True.
|
|
226
|
+
# False -> validación bloqueante: si a un parámetro le falta alguna tag obligatoria
|
|
227
|
+
# no se sube (ni su valor ni sus tags).
|
|
228
|
+
# True -> se permiten vacías: el parámetro se sube igualmente y las tags sin valor
|
|
229
|
+
# simplemente NO se crean en AWS (no se suben como etiquetas vacías).
|
|
150
230
|
obligatorias_vacias = False
|
|
151
231
|
|
|
232
|
+
# Tags que se exigen en cada parámetro cuando tags_activas = True. La lista es libre:
|
|
233
|
+
# estas 8 son las que sostienen el control de acceso ABAC vía IAM de nuestra cuenta.
|
|
152
234
|
tags_obligatorias = [
|
|
153
|
-
"Application",
|
|
154
|
-
"
|
|
235
|
+
"Application",
|
|
236
|
+
"Environment",
|
|
237
|
+
"Owner",
|
|
238
|
+
"Project",
|
|
239
|
+
"Product",
|
|
240
|
+
"Service",
|
|
241
|
+
"Component",
|
|
242
|
+
"ManagedBy",
|
|
155
243
|
]
|
|
156
244
|
```
|
|
157
245
|
Nota: Si el archivo paramsx_config.py ya existe, no será sobrescrito durante la instalación para proteger las configuraciones personalizadas.
|
|
158
246
|
|
|
159
|
-
###
|
|
247
|
+
### Los perfiles de naming
|
|
160
248
|
|
|
161
|
-
|
|
249
|
+
Cada organización nombra sus parámetros a su manera, así que ParamsX no impone ninguna convención: **tú defines los perfiles que uses en el diccionario `naming` y les pones el nombre que quieras**. Cada entrada de `parameter_list` declara con qué perfil se construye su ruta completa. Los tres campos de un perfil y sus valores están explicados en el propio fichero de configuración, ahí arriba.
|
|
162
250
|
|
|
163
|
-
|
|
164
|
-
|---|---|---|
|
|
165
|
-
| `min` | Convención nueva. Añade el entorno en **minúscula al principio** de la ruta. | `/rds` → `/dev/rds` |
|
|
166
|
-
| `max` | Convención legacy. Inserta el entorno en **mayúscula tras el primer segmento**. | `/API/STA` → `/API/DEV/STA` |
|
|
167
|
-
| `max` | Con un solo segmento queda al final. | `/EMAIL` → `/EMAIL/DEV` |
|
|
251
|
+
**No hay una lista cerrada de perfiles.** Los tres campos se combinan libremente, así que la plantilla no intenta traértelos todos: define los dos o tres que use tu organización y olvídate del resto. `min` y `max` vienen predefinidos porque son los que ParamsX traía antes de que los perfiles fueran configurables.
|
|
168
252
|
|
|
169
|
-
|
|
253
|
+
**Para qué sirve el `*`.** Además de colocar el entorno donde quieras, acota la lectura a un solo subárbol: con `/API/MULTIAPI/*/stan_ai` lees únicamente `/API/MULTIAPI/DEV/stan_ai`, en vez de todo lo que cuelga de `/API/MULTIAPI/DEV`. Debe ser un segmento entero, aparecer **exactamente una vez** y solo se admite en perfiles `mixto`: si el perfil y la ruta no cuentan la misma historia, ParamsX te lo dice al arrancar en vez de leer una ruta inexistente y devolverte una lista vacía.
|
|
170
254
|
|
|
171
|
-
|
|
255
|
+
**Los entornos.** Ya no existe la lista `entornos_old`: el entorno sale siempre de la lista canónica `entornos` (en minúscula), aplicándole el `case_entorno` del perfil. Si en tus rutas se llama `staging` en vez de `pre`, ponlo así en `entornos`.
|
|
172
256
|
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
{"path": "/rds", "convencion": "min"},
|
|
177
|
-
{"path": "/api", "convencion": "min"},
|
|
178
|
-
{"path": "/INFRA", "convencion": "max"},
|
|
179
|
-
{"path": "/API/STA", "convencion": "max"},
|
|
180
|
-
{"path": "/API/p15", "convencion": "max"},
|
|
181
|
-
{"path": "/API/MULTIAPI", "convencion": "max"},
|
|
182
|
-
{"path": "/APP/Alertas", "convencion": "max"},
|
|
183
|
-
{"path": "/API/ALERTAS", "convencion": "max"},
|
|
184
|
-
{"path": "/APP/Eter", "convencion": "max"},
|
|
185
|
-
{"path": "/API/GIS", "convencion": "max"},
|
|
186
|
-
{"path": "/API/PANGEA", "convencion": "max"},
|
|
187
|
-
{"path": "/BUCKETS", "convencion": "max"},
|
|
188
|
-
{"path": "/EMAIL", "convencion": "max"},
|
|
189
|
-
{"path": "/INFERENCIAS/TASA_DMI", "convencion": "max"},
|
|
190
|
-
{"path": "/IP", "convencion": "max"},
|
|
191
|
-
{"path": "/TASA", "convencion": "max"},
|
|
192
|
-
{"path": "/CEE/CEXGEN", "convencion": "max"},
|
|
193
|
-
]
|
|
194
|
-
```
|
|
257
|
+
Y ParamsX **no renombra ni fuerza el case de los parámetros que ya existen**: los lee y edita tal cual estén. El `case_ruta` del perfil solo entra en juego al crear parámetros nuevos.
|
|
258
|
+
|
|
259
|
+
### Un fichero por ruta: `fichero_por_ruta`
|
|
195
260
|
|
|
196
|
-
|
|
261
|
+
Al leer una ruta se generan `parameters_{entorno}.py` y su backup. Ese nombre depende solo del entorno, así que si lees una segunda ruta del mismo entorno **machacas el fichero de la primera**. Por defecto ParamsX te avisa y te pide confirmación antes de sobrescribir.
|
|
262
|
+
|
|
263
|
+
Si trabajas a menudo con varias rutas del mismo entorno, pon `fichero_por_ruta = True`: cada entrada pasa a tener su propio fichero y dejan de pisarse. Al cargar los verás todos en la lista y eliges cuál aplicar.
|
|
264
|
+
|
|
265
|
+
En el nombre van el entorno, la ruta y el perfil, porque dos entradas pueden compartir la ruta declarada y apuntar a sitios distintos:
|
|
266
|
+
|
|
267
|
+
| Entrada | Fichero |
|
|
268
|
+
|---|---|
|
|
269
|
+
| `{"path": "/API/STA", "convencion": "max"}` | `parameters_dev__API_STA__max.py` |
|
|
270
|
+
| `{"path": "/API/*/STA", "convencion": "mixto_max"}` | `parameters_dev__API_env_STA__mixto_max.py` |
|
|
197
271
|
|
|
198
272
|
### Cómo acotar tu parameter_list (recomendación)
|
|
199
273
|
|
|
@@ -204,22 +278,24 @@ Sobre mayúsculas y minúsculas: ParamsX **no renombra ni fuerza el case de los
|
|
|
204
278
|
|
|
205
279
|
Si configuras una ruta más amplia que tus permisos, no pasa nada grave: ParamsX te avisará con un mensaje claro de acceso denegado en vez de una traza de boto3. Pero afinar la ruta te ahorra el error.
|
|
206
280
|
|
|
207
|
-
### Tags obligatorias y el flag `
|
|
281
|
+
### Tags obligatorias y el flag `tags_activas`
|
|
208
282
|
|
|
209
|
-
|
|
283
|
+
En nuestra cuenta, el control de acceso a los valores privados va por **tags IAM** (condición `aws:ResourceTag/${TagKey}` sobre `GetParameter`), no por restricción de path — la única excepción es `/{entorno}/common/*`, que se concede por prefijo de ruta. Por eso estas 8 tags son ahí el mínimo no negociable: son las que sostienen todo el modelo ABAC.
|
|
210
284
|
|
|
211
285
|
```
|
|
212
286
|
Application, Environment, Owner, Project, Product, Service, Component, ManagedBy
|
|
213
287
|
```
|
|
214
288
|
|
|
215
|
-
La lista vive en `tags_obligatorias`, dentro de tu propio `paramsx_config.py
|
|
289
|
+
La lista vive en `tags_obligatorias`, dentro de tu propio `paramsx_config.py`: es libre, pon las que use tu organización.
|
|
216
290
|
|
|
217
|
-
El flag `
|
|
291
|
+
El flag `tags_activas` decide si ParamsX gestiona tags:
|
|
218
292
|
|
|
219
|
-
- **`
|
|
220
|
-
- **`
|
|
293
|
+
- **`tags_activas = True`**: al leer parámetros, el fichero exportado incluye un campo por tag con su valor actual en AWS (vacío si el parámetro es legacy y no la tiene). Al cargar, es **obligatorio** que todas tengan valor.
|
|
294
|
+
- **`tags_activas = False`**: las tags no aparecen en el fichero exportado en absoluto y no se valida nada (comportamiento de la 1.x).
|
|
221
295
|
|
|
222
|
-
|
|
296
|
+
Este flag se llamaba `abac` en la 2.0 y la 2.1. El nombre viejo se sigue aceptando, así que no tienes que tocar tu configuración, pero `tags_activas` describe lo que hace de verdad: activar la gestión de tags. Que esas tags sostengan un modelo ABAC es el motivo por el que tú las quieres, no lo que hace el flag.
|
|
297
|
+
|
|
298
|
+
Formato del fichero exportado con `tags_activas = True`:
|
|
223
299
|
|
|
224
300
|
```python
|
|
225
301
|
parametros = [
|
|
@@ -241,7 +317,7 @@ Este formato con tags **solo existe en el fichero temporal que genera ParamsX**:
|
|
|
241
317
|
|
|
242
318
|
#### `obligatorias_vacias`: cuando alguna tag tiene que ir vacía
|
|
243
319
|
|
|
244
|
-
En la práctica hay parámetros a los que no les aplica alguna de las 8 tags. Ese caso se controla con `obligatorias_vacias`, y solo tiene efecto si `
|
|
320
|
+
En la práctica hay parámetros a los que no les aplica alguna de las 8 tags. Ese caso se controla con `obligatorias_vacias`, y solo tiene efecto si `tags_activas = True`:
|
|
245
321
|
|
|
246
322
|
| `obligatorias_vacias` | Comportamiento |
|
|
247
323
|
|---|---|
|
|
@@ -250,14 +326,14 @@ En la práctica hay parámetros a los que no les aplica alguna de las 8 tags. Es
|
|
|
250
326
|
|
|
251
327
|
Ojo con la diferencia entre "vacía" y "borrada": con `obligatorias_vacias = True`, una tag que se deja en blanco y **nunca existió** simplemente no se crea; pero si esa tag **ya tenía valor en AWS** y la vacías en el fichero, se interpreta como que quieres borrarla y se elimina del parámetro. Es la forma de quitar una tag.
|
|
252
328
|
|
|
253
|
-
Detalles del comportamiento con `
|
|
329
|
+
Detalles del comportamiento con `tags_activas = True`:
|
|
254
330
|
|
|
255
|
-
- La validación es **por parámetro**, no global: con `obligatorias_vacias = False`, si a uno le falta cualquiera de las
|
|
331
|
+
- La validación es **por parámetro**, no global: con `obligatorias_vacias = False`, si a uno le falta cualquiera de las tags obligatorias no se sube ni su valor ni sus tags, y verás un error indicando qué tags faltan y a qué `parameter_name`. El resto de parámetros del fichero que estén completos se suben con normalidad.
|
|
256
332
|
- Cuando una carga queda a medias, los ficheros `parameters_{entorno}.py` y su backup **no se borran**, para que corrijas lo que falta y vuelvas a cargar. El backup se resincroniza con lo ya aplicado, así que la segunda pasada solo sube lo que quedó pendiente.
|
|
257
333
|
- Si el parámetro ya existe y le faltan tags (creado antes de esta versión), se rellenan en este mismo flujo de edición, sin borrar ni recrear el parámetro.
|
|
258
334
|
- Los cambios de tags se aplican con `add_tags_to_resource` / `remove_tags_from_resource` en la misma pasada que el valor. Vaciar el campo de una tag en el fichero equivale a borrarla en AWS.
|
|
259
335
|
- Las tags de sistema (`aws:*`) no se exportan ni se tocan. Las tags que ya existan en AWS y no estén en la lista obligatoria se conservan y se pueden editar.
|
|
260
|
-
- No hay forma de saltarse la validación por parámetro salvo relajarla explícitamente en tu configuración con `obligatorias_vacias = True`, o desactivar las tags por completo con `
|
|
336
|
+
- No hay forma de saltarse la validación por parámetro salvo relajarla explícitamente en tu configuración con `obligatorias_vacias = True`, o desactivar las tags por completo con `tags_activas = False`.
|
|
261
337
|
|
|
262
338
|
#### Configuración manual del PATH
|
|
263
339
|
En algunos sistemas (especialmente en entornos corporativos como Windows), el PATH puede no configurarse automáticamente durante la instalación. Si ocurre esto, sigue los pasos según tu sistema operativo:
|
|
@@ -280,7 +356,17 @@ En algunos sistemas (especialmente en entornos corporativos como Windows), el PA
|
|
|
280
356
|
```source ~/.zshrc # Para zsh```
|
|
281
357
|
|
|
282
358
|
Una vez instalado, verifica que el comando paramsx esté disponible ejecutando:
|
|
283
|
-
```paramsx --
|
|
359
|
+
```paramsx --version```
|
|
360
|
+
|
|
361
|
+
Comandos disponibles:
|
|
362
|
+
|
|
363
|
+
| Comando | Qué hace |
|
|
364
|
+
|---|---|
|
|
365
|
+
| `paramsx` | Abre el menú interactivo (necesita configuración). |
|
|
366
|
+
| `paramsx configure` | Crea la configuración la primera vez; si ya existe, la revisa sin tocarla. |
|
|
367
|
+
| `paramsx configure --ejemplo` | Además deja la plantilla de esta versión al lado, para comparar. |
|
|
368
|
+
| `paramsx --version` | Versión instalada. |
|
|
369
|
+
| `paramsx --help` | Ayuda, con el resumen de todas las opciones de configuración. |
|
|
284
370
|
|
|
285
371
|
|
|
286
372
|
## Modo de empleo
|
|
@@ -297,13 +383,13 @@ El programa mostrará un menú donde Podrás:
|
|
|
297
383
|
- Crear un parámetro nuevo.
|
|
298
384
|
|
|
299
385
|
### Leer Parámetros:
|
|
300
|
-
1. Selecciona la opción "Leer parámetros" en el menú. La lista muestra cada ruta con su
|
|
386
|
+
1. Selecciona la opción "Leer parámetros" en el menú. La lista muestra cada ruta con su perfil de naming, por ejemplo `/rds [min]` o `/API/STA [max]`.
|
|
301
387
|
2. Elige el prefijo y el entorno que deseas consultar.
|
|
302
388
|
3. Los parámetros serán descargados y guardados en archivos como:
|
|
303
389
|
- parameters_dev.py
|
|
304
390
|
- parameters_dev_backup.py
|
|
305
391
|
```Importante: Los archivos se generarán en la misma ruta desde donde ejecutes el comando paramsx```
|
|
306
|
-
4. Edita el archivo parameters_{entorno}.py con tu software favorito. Con `
|
|
392
|
+
4. Edita el archivo parameters_{entorno}.py con tu software favorito. Con `tags_activas = True` cada parámetro trae además un campo por cada tag obligatoria para rellenar.
|
|
307
393
|
|
|
308
394
|
### Cargar Parámetros:
|
|
309
395
|
1. Modifica los archivos generados (parameters_dev.py).
|
|
@@ -318,9 +404,9 @@ El programa mostrará un menú donde Podrás:
|
|
|
318
404
|
|
|
319
405
|
### Crear un parámetro nuevo:
|
|
320
406
|
1. Selecciona la opción "Crear nuevo parámetro" y elige el entorno.
|
|
321
|
-
2. Escribe la ruta
|
|
407
|
+
2. Escribe la ruta **sin el entorno**, como en tu `parameter_list`: ParamsX le aplica el perfil de `convencion_nuevos` y te enseña la ruta resultante en AWS para que la confirmes.
|
|
322
408
|
3. Escribe el valor: texto plano o JSON en una línea.
|
|
323
|
-
4. Rellena las tags obligatorias (si `
|
|
409
|
+
4. Rellena las tags obligatorias (si `tags_activas = True`). `Environment` viene precargada con el entorno elegido. Con `obligatorias_vacias = True` puedes dejar alguna en blanco pulsando Enter: esas no se crearán en AWS.
|
|
324
410
|
5. Confirma en la pantalla de resumen. Si es un parámetro de RDS y falta su contraparte (común o privado), verás el aviso de correlación de naming ahí mismo.
|
|
325
411
|
|
|
326
412
|
### Backup Parámetros:
|