Toggle menu
Toggle preferences menu
Toggle personal menu
Not logged in
Your IP address will be publicly visible if you make any edits.

Deployments/Template

From OHC Network Wiki
referencedeploymentsCARE 3.0+

Use this starter for every CARE deployment. Create the page as Deployments/<frontend-domain>, replace each HTML comment, remove fields that truly do not apply, and retain unknown applicable fields as Not documented so gaps remain visible.

Rules

  • Use the public frontend domain as both the page suffix and name.
  • Use ISO 8601 dates: YYYY-MM-DD; pin deployed code to a commit or immutable release tag where possible.
  • Name accountable organisations and roles. Link internal teams or contacts where the wiki access policy permits it.
  • Add each frontend, backend, or paired CARE plugin with {{DeploymentPlugin}}. The plugin inventory supplies ownership and repository links automatically.
  • Record secret identifiers and the secret manager only. Never record credentials, tokens, keys, connection strings, patient data, private addresses, or access-control bypasses.
  • Link to restricted operational systems rather than duplicating sensitive contents here.
  • Set documentation_status=verified only after the named review owner checks the record against the live deployment.
  • Review production records after material architecture changes and at least quarterly.

Copyable page

{{Doc header
|type=reference
|domain=deployments
|title=INSTANCE.DOMAIN
|summary=One-sentence description of this CARE instance
}}

Brief narrative: who uses this deployment, where, and why it exists.

{{Deployment
<!-- Identity and accountability -->
|name=INSTANCE.DOMAIN
|url=https://INSTANCE.DOMAIN
|api_url=
|status_url=
|documentation_url=
|type=production
|status=active
|documentation_status=draft
|project=
|geography=
|go_live_date=
|owner_org=
|operator_org=
|supported_by=
|implementation_partner=
|clinical_owner=
|technical_owner=
|data_controller=
|review_owner=
|support_contact=
|support_hours=
|escalation_policy=
|billing_owner=
|cost_notes=

<!-- Service scope -->
|purpose=
|scope=
|facilities=
|user_groups=
|data_classification=
|service_tier=

<!-- Frontend -->
|fe_repo=https://github.com/ORG/REPOSITORY
|fe_branch=
|fe_commit=
|fe_provider=
|fe_detail=

<!-- Backend -->
|be_repo=https://github.com/ORG/REPOSITORY
|be_branch=
|be_commit=
|be_provider=
|be_detail=
|be_web_replicas=
|be_worker_replicas=
|be_beat_replicas=

<!-- Data and platform -->
|hosting_provider=
|regions=
|runtime=
|network_topology=
|db_provider=
|db_detail=
|db_change_process=
|storage_provider=
|storage_detail=
|storage_change_process=
|cache_detail=
|queue_detail=
|search_detail=
|identity_provider=
|messaging_detail=
|external_dependencies=

<!-- Delivery -->
|last_deployed=
|ci_cd=
|configuration_source=
|release_policy=
|change_records=
|validation_process=

<!-- Security and privacy; never put secret values here -->
|access_control=
|secrets_management=
|encryption=
|audit_logging=
|privacy_retention=
|compliance=

<!-- Operations -->
|monitoring=
|alerting=
|logging_tracing=
|service_objectives=
|runbook_url=
|dashboard_url=
|incident_process=
|routine_operations=

<!-- Continuity -->
|backup_policy=
|restore_testing=
|rpo=
|rto=
|disaster_recovery=
|decommissioning=

<!-- Risks and review -->
|known_risks=
|architecture_decisions=
|open_actions=
|last_reviewed=
|next_review=
}}

<!-- One call per plugin. Slug must match a page under Plugins/. -->
{{DeploymentPlugin
|deployment=INSTANCE.DOMAIN
|plugin=PLUGIN_SLUG
|enabled=true
|config_overrides=Non-secret feature flags or configuration references only
}}

{{Navbox OHC}}

Completion checklist

  1. Identity, URL, environment, lifecycle state, purpose, geography, and service criticality are current.
  2. Accountable owner, operator, support route, technical owner, clinical/product owner, data controller, billing owner, and review owner are named.
  3. Frontend and backend repositories, immutable revisions, runtime topology, replica counts, providers, regions, and all data services are recorded.
  4. Every enabled CARE plugin is linked and its frontend/backend scope, maintainer, repositories, and non-secret configuration are correct.
  5. CI/CD, configuration source, approvals, validation, rollback, maintenance windows, and change records are linked.
  6. Authentication, authorization, privileged access, secrets, encryption, audit, privacy, retention, residency, and compliance controls are described.
  7. Monitoring, alerts, logs, traces, service objectives, support hours, incident route, runbooks, dashboards, and recurring maintenance have owners.
  8. Backup scope, retention, restore evidence, RPO, RTO, disaster recovery, failback, and decommissioning are covered.
  9. Known risks, decisions, open actions, last review, next review, and reviewer are current.