mirror of https://github.com/OpenVidu/openvidu.git
openvidu-deployment: translate GCP HA DOC-CHANGES to English
Piwccle
parent
1794e7e16b
commit
0a587eb33e
|
|
@ -1,144 +1,145 @@
|
|||
# Cambios de documentación para `ha-optimizations` (despliegue HA GCP)
|
||||
# Documentation changes for `ha-optimizations` (GCP HA deployment)
|
||||
|
||||
Instrucciones para el Claude que trabaje en el repo de docs
|
||||
`/home/sergio/Escritorio/openvidu/openvidu.io` (rama `next`, ya actualizada).
|
||||
Instructions for the Claude working on the docs repo
|
||||
`/home/sergio/Escritorio/openvidu/openvidu.io` (branch `next`, already up to date).
|
||||
|
||||
Estas instrucciones derivan de los cambios aplicados en
|
||||
`openvidu-deployment/pro/ha/gcp/tf-gpc-openvidu-ha.tf` en la rama `ha-optimizations`
|
||||
(paralelización de los 4 master nodes, IPs internas estáticas para los masters,
|
||||
timeouts en las esperas, fetch robusto del instalador y `depends_on` hacia las APIs).
|
||||
These instructions derive from the changes applied in
|
||||
`openvidu-deployment/pro/ha/gcp/tf-gpc-openvidu-ha.tf` on the `ha-optimizations` branch
|
||||
(parallelization of the 4 master nodes, static internal IPs for the masters,
|
||||
wait timeouts, robust installer fetch, and `depends_on` on the APIs).
|
||||
|
||||
RESUMEN: el ÚNICO cambio de contenido necesario son las dos cifras de tiempo de
|
||||
despliegue en el `install.md` del HA de GCP. Todo lo demás (parámetros públicos,
|
||||
capturas, otros clouds, otros deployment types, ficheros de config on-node) se
|
||||
mantiene igual. Léelo entero antes de tocar nada.
|
||||
SUMMARY: the ONLY content change required is the two deployment time figures in
|
||||
GCP HA's `install.md`. Everything else (public parameters, screenshots, other clouds,
|
||||
other deployment types, on-node config files) stays the same. Read it in full before
|
||||
touching anything.
|
||||
|
||||
---
|
||||
|
||||
## (a) Cifras de tiempo a actualizar — OBLIGATORIO
|
||||
## (a) Time figures to update — MANDATORY
|
||||
|
||||
Fichero: `docs/docs/self-hosting/ha/gcp/install.md`
|
||||
File: `docs/docs/self-hosting/ha/gcp/install.md`
|
||||
|
||||
Hay DOS ocurrencias de "7 to 12 minutes" en este fichero (aprox. líneas 249 y 308).
|
||||
Localízalas por el texto literal, no confíes solo en el número de línea (puede haberse
|
||||
desplazado). Sustituye la cifra por el placeholder y deja una nota para rellenarla con
|
||||
la medición real de `ov-cloud-tester` tras estos cambios (el despliegue ahora es más
|
||||
rápido: masters en paralelo y sin el handshake de IPs por Secret Manager).
|
||||
There are TWO occurrences of "7 to 12 minutes" in this file (approx. lines 249 and 308).
|
||||
Locate them by the literal text; do not rely only on the line number (it may have
|
||||
shifted). Replace the figure with the placeholder and leave a note to fill it in with
|
||||
the actual measurement from `ov-cloud-tester` after these changes (the deployment is now
|
||||
faster: masters run in parallel and there is no more IP handshake via Secret Manager).
|
||||
|
||||
### Ocurrencia 1 (sección "## Deploying the stack", ~línea 249)
|
||||
### Occurrence 1 (section "## Deploying the stack", ~line 249)
|
||||
|
||||
Texto actual literal:
|
||||
Current literal text:
|
||||
|
||||
```
|
||||
When you are satisfied with your input values, click _"Continue"_ and then _"Create deployment"_. The deployment will be validated and all resources will be created. Wait around 7 to 12 minutes for the nodes to install OpenVidu.
|
||||
```
|
||||
|
||||
Texto propuesto (rellenar `X`/`Y` con la medición de `ov-cloud-tester`):
|
||||
Proposed text (fill in `X`/`Y` with the measurement from `ov-cloud-tester`):
|
||||
|
||||
```
|
||||
When you are satisfied with your input values, click _"Continue"_ and then _"Create deployment"_. The deployment will be validated and all resources will be created. Wait around X to Y minutes for the nodes to install OpenVidu.
|
||||
```
|
||||
|
||||
### Ocurrencia 2 (sección "## Checking...", ~línea 308)
|
||||
### Occurrence 2 (section "## Checking...", ~line 308)
|
||||
|
||||
Texto actual literal:
|
||||
Current literal text:
|
||||
|
||||
```
|
||||
When your Google Cloud Platform deployment reaches the **`Active`** state, it means that all resources have been created. You will need to wait about 7 to 12 minutes for the instances to install OpenVidu, as mentioned before. After this time, try connecting to the deployment URL. If it doesn't work, we recommend checking the previous section. Once everything is ready, you can check the [Administration](./admin.md) section to learn how to manage your deployment.
|
||||
```
|
||||
|
||||
Texto propuesto (rellenar `X`/`Y` con la medición de `ov-cloud-tester`):
|
||||
Proposed text (fill in `X`/`Y` with the measurement from `ov-cloud-tester`):
|
||||
|
||||
```
|
||||
When your Google Cloud Platform deployment reaches the **`Active`** state, it means that all resources have been created. You will need to wait about X to Y minutes for the instances to install OpenVidu, as mentioned before. After this time, try connecting to the deployment URL. If it doesn't work, we recommend checking the previous section. Once everything is ready, you can check the [Administration](./admin.md) section to learn how to manage your deployment.
|
||||
```
|
||||
|
||||
> Placeholder a rellenar: `X to Y minutes — rellenar con la medición de ov-cloud-tester`.
|
||||
> Mantén las dos ocurrencias con la MISMA cifra (la segunda dice "as mentioned before").
|
||||
> Placeholder to fill in: `X to Y minutes — fill in with the measurement from ov-cloud-tester`.
|
||||
> Keep both occurrences with the SAME figure (the second one says "as mentioned before").
|
||||
|
||||
### NO tocar las cifras de otros ficheros
|
||||
### Do NOT touch the figures in other files
|
||||
|
||||
Estos cambios afectan SOLO al HA de GCP. NO modifiques las cifras "7 to 12 minutes"
|
||||
que aparecen en otros documentos (son otros clouds / otros deployment types y están
|
||||
fuera del alcance de este trabajo):
|
||||
These changes affect ONLY GCP HA. Do NOT modify the "7 to 12 minutes" figures
|
||||
that appear in other documents (they belong to other clouds / other deployment types and
|
||||
are out of scope for this work):
|
||||
|
||||
- `docs/docs/self-hosting/elastic/gcp/install.md` (líneas ~236 y ~295)
|
||||
- `docs/docs/self-hosting/elastic/azure/install.md` (líneas ~95 y ~149)
|
||||
- Cualquier otro `install.md` de la doc.
|
||||
- `docs/docs/self-hosting/elastic/gcp/install.md` (lines ~236 and ~295)
|
||||
- `docs/docs/self-hosting/elastic/azure/install.md` (lines ~95 and ~149)
|
||||
- Any other `install.md` in the docs.
|
||||
|
||||
---
|
||||
|
||||
## (b) Parámetros públicos de la plantilla GCP: SIN CAMBIOS — confirmación
|
||||
## (b) GCP template public parameters: NO CHANGES — confirmation
|
||||
|
||||
NO hay que tocar tablas de parámetros ni capturas de la sección de parámetros.
|
||||
Do not touch parameter tables or screenshots in the parameters section.
|
||||
|
||||
Motivo: las nuevas IPs estáticas de los master nodes son **internas**
|
||||
(`google_compute_address` con `address_type = "INTERNAL"`, reservadas dentro de la
|
||||
subred `default` de la región) y se asignan vía `network_interface.network_ip`. No se
|
||||
ha añadido, eliminado ni renombrado ninguna variable de entrada ni salida de Terraform
|
||||
(`variables.tf` y `output.tf` intactos). Por tanto:
|
||||
Reason: the new static IPs of the master nodes are **internal**
|
||||
(`google_compute_address` with `address_type = "INTERNAL"`, reserved within the
|
||||
region's `default` subnet) and are assigned via `network_interface.network_ip`. No
|
||||
Terraform input or output variable has been added, removed, or renamed
|
||||
(`variables.tf` and `output.tf` unchanged). Therefore:
|
||||
|
||||
- La tabla "Mandatory Parameters" y "Optional Parameters" de
|
||||
`docs/docs/self-hosting/ha/gcp/install.md` (aprox. líneas 95–230) **se queda igual**.
|
||||
- No hay parámetros nuevos que el usuario deba introducir en Infrastructure Manager.
|
||||
- Las capturas del formulario de parámetros **no cambian**.
|
||||
- The "Mandatory Parameters" and "Optional Parameters" table in
|
||||
`docs/docs/self-hosting/ha/gcp/install.md` (approx. lines 95–230) **stays the same**.
|
||||
- There are no new parameters the user needs to enter in Infrastructure Manager.
|
||||
- The parameter form screenshots **do not change**.
|
||||
|
||||
---
|
||||
|
||||
## (c) Otras afirmaciones de la doc GCP HA que puedan quedar obsoletas
|
||||
## (c) Other statements in the GCP HA docs that may become outdated
|
||||
|
||||
Se ha revisado toda la doc del HA de GCP (`docs/docs/self-hosting/ha/gcp/*.md`) y los
|
||||
includes compartidos. Conclusiones:
|
||||
The entire GCP HA documentation (`docs/docs/self-hosting/ha/gcp/*.md`) and the shared
|
||||
includes have been reviewed. Conclusions:
|
||||
|
||||
### c.1 — Secretos `MASTER_NODE_{1..4}_PRIVATE_IP` de Secret Manager (ELIMINADOS)
|
||||
### c.1 — Secret Manager secrets `MASTER_NODE_{1..4}_PRIVATE_IP` (REMOVED)
|
||||
|
||||
En `ha-optimizations` se han eliminado del despliegue los 4 secretos de Secret Manager
|
||||
`MASTER_NODE_1_PRIVATE_IP` … `MASTER_NODE_4_PRIVATE_IP` (ya no se generan: las IPs de
|
||||
los masters son ahora estáticas y se pasan por metadata). La doc del HA de GCP **no los
|
||||
menciona por nombre en el texto**, así que no hay texto que corregir.
|
||||
In `ha-optimizations`, the 4 Secret Manager secrets
|
||||
`MASTER_NODE_1_PRIVATE_IP` … `MASTER_NODE_4_PRIVATE_IP` have been removed from the
|
||||
deployment (they are no longer generated: the masters' IPs are now static and are
|
||||
passed via metadata). The GCP HA docs **do not mention them by name in the text**, so
|
||||
there is no text to fix.
|
||||
|
||||
- Único impacto posible: la captura del Secret Manager en
|
||||
`install.md` (sección "Check deployment outputs in GCP Secret Manager"),
|
||||
imagen `assets/images/platform/self-hosting/shared/gcp/secrets-manager.png`.
|
||||
Esa captura PODRÍA mostrar los 4 secretos de IP que ya no existirán. Es puramente
|
||||
cosmético (el texto solo dice "you will see all the secrets by their name"). Acción
|
||||
OPCIONAL: si se regenera la captura en algún momento, hacerlo tras un despliegue con
|
||||
`ha-optimizations`. NO es bloqueante para este cambio.
|
||||
- Only possible impact: the Secret Manager screenshot in
|
||||
`install.md` (section "Check deployment outputs in GCP Secret Manager"),
|
||||
image `assets/images/platform/self-hosting/shared/gcp/secrets-manager.png`.
|
||||
That screenshot COULD show the 4 IP secrets that will no longer exist. It is purely
|
||||
cosmetic (the text only says "you will see all the secrets by their name"). OPTIONAL
|
||||
action: if the screenshot is regenerated at some point, do it after a deployment with
|
||||
`ha-optimizations`. This is NOT blocking for this change.
|
||||
|
||||
### c.2 — `backup-and-restore.md`: NO TOCAR
|
||||
### c.2 — `backup-and-restore.md`: DO NOT TOUCH
|
||||
|
||||
`docs/docs/self-hosting/how-to-guides/backup-and-restore.md` (aprox. líneas 676–692)
|
||||
documenta variables `MASTER_NODE_1_PRIVATE_IP` … `MASTER_NODE_4_PRIVATE_IP` dentro del
|
||||
fichero de configuración on-node `/opt/openvidu/config/node/master-node.env`.
|
||||
`docs/docs/self-hosting/how-to-guides/backup-and-restore.md` (approx. lines 676–692)
|
||||
documents the variables `MASTER_NODE_1_PRIVATE_IP` … `MASTER_NODE_4_PRIVATE_IP` inside
|
||||
the on-node configuration file `/opt/openvidu/config/node/master-node.env`.
|
||||
|
||||
IMPORTANTE: **esas NO son los secretos eliminados**. Son variables del fichero de
|
||||
configuración que el instalador sigue escribiendo a partir del flag
|
||||
`--master-node-private-ip-list` (que se sigue pasando, ahora derivado de las IPs
|
||||
estáticas). Ese flujo no cambia. **No modifiques `backup-and-restore.md`.**
|
||||
IMPORTANT: **these are NOT the removed secrets**. They are configuration file
|
||||
variables that the installer still writes based on the
|
||||
`--master-node-private-ip-list` flag (which is still passed, now derived from the
|
||||
static IPs). That flow does not change. **Do not modify `backup-and-restore.md`.**
|
||||
|
||||
### c.3 — `upgrade.md`: NO TOCAR
|
||||
### c.3 — `upgrade.md`: DO NOT TOUCH
|
||||
|
||||
`docs/docs/self-hosting/ha/gcp/upgrade.md` (línea ~91) menciona `store_secret.sh` y el
|
||||
secreto `OPENVIDU_VERSION`. Ni el script `store_secret.sh` ni el secreto
|
||||
`OPENVIDU_VERSION` se han tocado. **No requiere cambios.**
|
||||
`docs/docs/self-hosting/ha/gcp/upgrade.md` (line ~91) mentions `store_secret.sh` and
|
||||
the `OPENVIDU_VERSION` secret. Neither the `store_secret.sh` script nor the
|
||||
`OPENVIDU_VERSION` secret has been touched. **No changes required.**
|
||||
|
||||
### c.4 — Flujo interno (ALL_SECRETS_GENERATED, handshake de IPs): no documentado
|
||||
### c.4 — Internal flow (ALL_SECRETS_GENERATED, IP handshake): not documented
|
||||
|
||||
El mecanismo interno de coordinación (líder master-1 genera secretos y marca
|
||||
`ALL_SECRETS_GENERATED`, polling, etc.) no está documentado públicamente, y su cambio
|
||||
(eliminación del intercambio de IPs por Secret Manager) no altera nada de cara al
|
||||
usuario. No hay texto que actualizar.
|
||||
The internal coordination mechanism (master-1 leader generates secrets and marks
|
||||
`ALL_SECRETS_GENERATED`, polling, etc.) is not publicly documented, and its change
|
||||
(removal of the IP exchange via Secret Manager) does not change anything user-facing.
|
||||
There is no text to update.
|
||||
|
||||
---
|
||||
|
||||
## Checklist de aplicación
|
||||
## Implementation checklist
|
||||
|
||||
- [ ] En `docs/docs/self-hosting/ha/gcp/install.md`, sustituir "7 to 12 minutes" por
|
||||
"X to Y minutes" en las DOS ocurrencias (~249 y ~308), con la misma cifra en ambas.
|
||||
- [ ] Medir el tiempo real de despliegue con `ov-cloud-tester` sobre `ha-optimizations`
|
||||
y rellenar `X`/`Y`.
|
||||
- [ ] Verificar que NO se han tocado tablas de parámetros ni capturas.
|
||||
- [ ] Verificar que NO se han tocado `backup-and-restore.md`, `upgrade.md`, ni las
|
||||
cifras de tiempo de elastic/azure/otros clouds.
|
||||
- [ ] (Opcional) Regenerar `secrets-manager.png` si se desea reflejar la ausencia de los
|
||||
4 secretos de IP.
|
||||
- [ ] In `docs/docs/self-hosting/ha/gcp/install.md`, replace "7 to 12 minutes" with
|
||||
"X to Y minutes" in the TWO occurrences (~249 and ~308), using the same figure in both.
|
||||
- [ ] Measure the actual deployment time with `ov-cloud-tester` on `ha-optimizations`
|
||||
and fill in `X`/`Y`.
|
||||
- [ ] Verify that NO parameter tables or screenshots have been touched.
|
||||
- [ ] Verify that `backup-and-restore.md`, `upgrade.md`, and the elastic/azure/other
|
||||
clouds time figures have NOT been touched.
|
||||
- [ ] (Optional) Regenerate `secrets-manager.png` if you want to reflect the absence of
|
||||
the 4 IP secrets.
|
||||
|
|
|
|||
Loading…
Reference in New Issue