Files
scadaproj/nam_ad_requests.md
T

105 lines
9.3 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# NAM AD requests: accounts and groups
Everything the family needs **created or confirmed in NAM Active Directory** (`nam.zimmer.com`) for the NAM LDAP
cutover and the related issues, broken out by environment and app. Use this file when raising ServiceNow/IT tickets.
- Plan: [`docs/plans/2026-11-15-nam-ldap-cutover.md`](docs/plans/2026-11-15-nam-ldap-cutover.md)
- Matrix: [`ldap_mapping.md`](ldap_mapping.md)
- Directory facts and 08-12 counts: [`ldap_setup.md`](ldap_setup.md)
- Umbrella: scadaproj#6
**Status as of 2026-11-17: nothing requested yet.** Names marked *(proposed)* are our suggestion; IT's naming
convention wins.
**Environments:**
- **DEV** = wonder-app-vd03.
- **QA** = wonder-app-vq03/vq04.
- **PROD** = no production box has been identified yet (`deployment.md`). The current cutover plan covers DEV
and QA only, so the PROD rows are **planned and provisional**: request them when a PROD deployment is
scheduled, or together with DEV/QA if IT prefers one ticket.
**Separation rule:**
- PROD gets **its own accounts**. A non-production mistake (a mistyped secret, a lockout, a leaked
credential) must not reach PROD.
- Each deployment maps **only its own group suffix** (`_DEV`/`_QA`/`_PROD`; `ldap_mapping.md` §3).
## 1. New accounts
| # | Account | Type | Env | Used by | Purpose | Required access | Password and policy | Blocks | Issue |
|---|---|---|---|---|---|---|---|---|---|
| A1 | `svc_zbmomww` *(proposed)* | Service account (LDAP lookup) | **DEV + QA**, shared (per-tier only if IT prefers) | OtOpcUa, ScadaBridge, MxAccessGateway, HistorianGateway | Service bind for user search and group reads at login; ScadaBridge group refresh (#46) | **Read-only** search of users (`sAMAccountName`, `userPrincipalName`, `displayName`, `memberOf`) and `UG_WW_*` groups. No interactive or RDP logon. LDAPS 636 to nam1/nam2 | Non-expiring, or managed rotation with notice. **No lockout**, or a very high threshold: one bad secret costs 2 binds per login across 4 apps × 2 tiers | QA cutover (all apps). DEV can run on `svc_igntadmin` as an interim, **only with the Ignition team's agreement** | scadaproj#58 |
| A1P | `svc_zbmomww_prod` *(proposed)* | Service account (LDAP lookup) | **PROD** | Same four apps | Same as A1, for PROD | Same as A1 | Same as A1. **Never shared with DEV/QA** | PROD cutover (all apps) | scadaproj#58 (extend) |
| A2 | `svc_zbmomww_auto_dev` *(proposed)* | **User-type** identity (interactive sign-in) | DEV | ScadaBridge CLI, deploy scripts, drills; OtOpcUa scripts if DEV AdminUI login is on | Replaces the login-off dev user once DEV login turns on | Member of `UG_WW_APP_ADMIN_DEV`, `UG_WW_APP_IDE_DEV` and `UG_WW_APP_DEPLOY_DEV` | Non-expiring or managed; stored in the Mac Keychain only | DEV ScadaBridge step (plan D3). Interim: a named admin's own account | scadaproj#6 (D3) |
| A3 | `svc_zbmomww_auto_qa` *(proposed)* | **User-type** identity (interactive sign-in) | QA | Same as A2 | Replaces the GLAuth `multi-role` user on QA | Member of `UG_WW_APP_ADMIN_QA`, `UG_WW_APP_IDE_QA` and `UG_WW_APP_DEPLOY_QA` | As A2 | QA ScadaBridge step (plan D3) | scadaproj#6 (D3) |
| A3P | `svc_zbmomww_auto_prod` *(proposed)* | **User-type** identity (interactive sign-in) | PROD | Deploy and verify automation, if PROD automation is allowed | PROD deploys run as a named identity, not a person | Member of `UG_WW_APP_DEPLOY_PROD`, plus `UG_WW_APP_IDE_PROD` only if automation authors config there. **Not `APP_ADMIN_PROD`** unless the owner decides otherwise | As A2; a tighter rotation is recommended | PROD ScadaBridge deploys. **Owner decision:** whether PROD allows an automation identity at all | scadaproj#6 (D3, PROD extension) |
| A4 | `svc_zbhistgw` *(proposed)* | Service account (**AVEVA Historian**, not LDAP) | DEV + QA, shared or one per tier | HistorianGateway → Historian gRPC (`wonder-sql-vd03`, `wonder-sql-vq03`) | Replaces the personal `NAM\dohertj2` that DEV and QA use today | Historian read/write on the DEV and QA Historian hosts | Non-expiring or managed; stored as `${secret:}` in HG's store | Not the cutover. A personal-account outage breaks DEV and QA historian access together | historiangw#134 |
| A4P | `svc_zbhistgw_prod` *(proposed)* | Service account (**AVEVA Historian**) | PROD | HistorianGateway → PROD Historian | Same as A4, for PROD | Historian access on the PROD Historian host (read/write only if PROD historization writes are in scope) | As A4. **Never shared with DEV/QA** | A PROD HistorianGateway deployment | historiangw#134 (extend) |
The LDAP-lookup accounts (A1/A1P) must not double as sign-in identities (A2/A3/A3P) unless IT agrees.
## 2. New groups
| # | Group | Env | App | Role granted | Why it's needed | Initial members | Blocks | Issue |
|---|---|---|---|---|---|---|---|---|
| G1 | `UG_WW_APP_DEPLOY_DEV` *(proposed)* | DEV | ScadaBridge | `Deployer` | One group = one role, and ScadaBridge `Administrator` does **not** include `Deployer`. Without it, no NAM user can deploy | Deployers on DEV + A2 | DEV ScadaBridge cutover | scadaproj#6 (D6) |
| G2 | `UG_WW_APP_DEPLOY_QA` *(proposed)* | QA | ScadaBridge | `Deployer` | Same as G1 | Deployers on QA + A3 | QA ScadaBridge cutover | scadaproj#6 (D6) |
| G3 | `UG_WW_APP_DEPLOY_PROD` *(proposed)* | PROD | ScadaBridge | `Deployer` | Same as G1. In PROD it should be the **smallest** group: the people (and A3P) allowed to change production | Named PROD deployers (owner to list) + A3P | PROD ScadaBridge cutover | scadaproj#6 (D6) |
## 3. Existing groups to confirm (membership and exact name)
All existed on 2026-08-12, with the member counts shown (DEV / QA / PROD, from `ldap_setup.md`). They are
unverified since. **Confirm the exact spelling and case** (HistorianGateway matches case-sensitively until
historiangw#136 ships) and **who is in each**. A user in none of them can't log in to any app.
| Group family | OtOpcUa | ScadaBridge | MxAccessGateway | HistorianGateway | DEV | QA | PROD |
|---|---|---|---|---|---|---|---|
| `UG_WW_APP_ADMIN_<T>` | Administrator | Administrator | Administrator | Administrator | 7 | 6 | 5 |
| `UG_WW_APP_IDE_<T>` | Designer | Designer | Viewer | — | 6 | 6 | 4 |
| `UG_WW_APP_IDE_RO_<T>` | Viewer | Viewer | Viewer | Viewer | 2 | 1 | 1 |
| `UG_WW_HIST_ADMIN_<T>` | Viewer | — | — | Administrator | 7 | 6 | 4 |
| `UG_WW_BTMGR_RO_<T>` | — | Viewer | — | Viewer | *(no group)* | **0 (empty)** | 4 |
`<T>` is the deployment's own suffix: `DEV`, `QA` or `PROD`.
**PROD review:** the PROD groups were built for AVEVA System Platform. Mapping them means their members gain
these apps' roles in PROD too. For example, all 5 `APP_ADMIN_PROD` members become Administrator in every app. The
owner should confirm each PROD membership list before the PROD mapping, not just the group names.
Out of scope for this cutover:
- `UG_WW_CITRIX_*` is never mapped. It is desktop/session access; DEV and QA groups exist, there is no PROD group.
- Plant-floor, site and batch groups (`*_OPERATOR`, `*_ENGINEER`, `SITE_ADMIN_*`, `BTMGR_{BE,MC}_*`, …)
(`ldap_mapping.md` §4.2).
To check one person or a group family: `tools/LdapProbe` (plan §5 D7), for example `-g 'UG_WW_*'`.
## 4. Summary by environment
| Env | Hosts | New accounts | New groups | Groups to confirm | When |
|---|---|---|---|---|---|
| **DEV** | wonder-app-vd03 | A1 (shared with QA), A2, A4 (shared with QA or DEV-only) | G1 | `APP_ADMIN_DEV`, `APP_IDE_DEV`, `APP_IDE_RO_DEV`, `HIST_ADMIN_DEV` | Now (cutover plan) |
| **QA** | wonder-app-vq03 / vq04 | A1 (shared with DEV), A3, A4 (shared with DEV or QA-only) | G2 | `APP_ADMIN_QA`, `APP_IDE_QA`, `APP_IDE_RO_QA`, `HIST_ADMIN_QA`, `BTMGR_RO_QA` (empty) | Now (cutover plan) |
| **PROD** | **not identified** | A1P, A3P (if allowed), A4P | G3 | `APP_ADMIN_PROD`, `APP_IDE_PROD`, `APP_IDE_RO_PROD`, `HIST_ADMIN_PROD`, `BTMGR_RO_PROD`, **plus a membership review** | When a PROD deployment is scheduled |
## 5. Summary by app
The same pattern applies in every environment; `<T>` is `DEV`, `QA` or `PROD`.
| App | LDAP-lookup account | Sign-in / automation account | Other account | Groups it maps (per env) |
|---|---|---|---|---|
| **OtOpcUa** (AdminUI) | A1 (DEV/QA), A1P (PROD) | A2/A3/A3P for scripts if login is on | — | `APP_ADMIN_<T>`, `APP_IDE_<T>`, `APP_IDE_RO_<T>`, `HIST_ADMIN_<T>` |
| **ScadaBridge** (Central UI, CLI) | A1 / A1P (login + group refresh) | A2 / A3 / A3P (CLI and automation) | — | `APP_ADMIN_<T>`, `APP_IDE_<T>`, **`APP_DEPLOY_<T>` (new)**, `APP_IDE_RO_<T>`, `BTMGR_RO_<T>` (QA/PROD) |
| **MxAccessGateway** (dashboard) | A1 / A1P | — | — | `APP_ADMIN_<T>`, `APP_IDE_<T>`, `APP_IDE_RO_<T>` |
| **HistorianGateway** (dashboard + Historian) | A1 / A1P (dashboard login) | — | A4 / A4P (Historian data access) | `APP_ADMIN_<T>`, `APP_IDE_RO_<T>`, `HIST_ADMIN_<T>`, `BTMGR_RO_<T>` (QA/PROD) |
| Overview | none (no login by design) | — | — | none |
## 6. Ticket checklist
| Ticket | Contents | Env | Tracked in |
|---|---|---|---|
| T1 | A1: LDAP-lookup service account, no lockout | DEV + QA | scadaproj#58 |
| T2 | A2 + A3: automation sign-in identities, with group memberships | DEV, QA | scadaproj#6 D3 |
| T3 | G1 + G2: `UG_WW_APP_DEPLOY_{DEV,QA}` | DEV, QA | scadaproj#6 D6 |
| T4 | A4: Historian service account | DEV + QA | historiangw#134 |
| T5 | Membership confirmation for the existing DEV/QA groups | DEV, QA | scadaproj#6 D7 |
| T6 *(later)* | A1P, A3P, A4P, G3, plus the PROD membership review | PROD | not filed yet; raise when PROD is scheduled |