Reference

Quick Command Reference

Initial Setup

# Using pip
pip install copier
copier copy https://coderepo.mobilehealth.va.gov/scm/ckm/ngss-devops-template.git . --trust

# Using Maven
mvn filegen:copier-init -Dcopier.template=devops

Updates

# Standard update
copier update -a .copier-answers/devops.yaml

# Re-prompt specific questions
copier update --ask version --ask service_dependencies -a .copier-answers/devops.yaml

# Update with data file
copier update -a .copier-answers/devops.yaml --data-file deps.yaml

# Update to specific version
copier update --vcs-ref v1.2.0 -a .copier-answers/devops.yaml

Check for Updates

copier check-update -a .copier-answers/devops.yaml .

All Configuration Variables

Common Variables

Variable Type Description

artifact_id

str

Maven artifact ID

version

str

Service version

dtr_org

str

Docker registry org

coderepo_project_key

str

Bitbucket project key

issues_server_host_url

str

Issue tracker URL

project_type

choice

service, web, library

major_version

str

Major version prefix (v1)

DevOps Variables

Variable Type Description

context_dir

str

Skaffold context directory

add_sql_configmap

bool

Include SQL configmap

service_dependencies

yaml

List of service dependencies

service_git_base_url

str

Git base URL

default_kustomize_path

str

Default kustomize path

VAEC Variables

Variable Type Description

vaec_ckid

str

Cost Key ID

vaec_vasi

str

Tenant ID

vaec_product

str

Product name

vaec_product_line

str

Product line

vaec_application_service

str

Service type

vaec_application_name

str

Application name

vaec_service_shortname

str

Short name for Dynatrace

Profile Variables

Variable Type Default

include_profile_dev_with_dependencies

bool

true

include_profile_map_sandbox_deploy

bool

false

include_profile_map_staging_deploy

bool

true

include_profile_map_prod_deploy

bool

true

include_profile_sandbox_build_test

bool

true

include_profile_staging_build_test

bool

true

include_profile_debug_all

bool

false

include_profile_vault_test

bool

varies

Skaffold Profiles

Profile Purpose

default

Local development with service dependencies

sandbox-build-test

Build and test for sandbox environment

staging-build-test

Build and test for staging environment

map-sandbox-deploy

Deploy to MAP sandbox cluster

map-staging-deploy

Deploy to MAP staging cluster

map-prod-deploy

Deploy to MAP production cluster

debug-all

Debug mode with all services

vault-test

Vault integration testing

Useful Scripts

Script Purpose

scripts/localize.sh

Generate localized kustomize overlays

scripts/validate-skaffold.sh

Validate Skaffold configuration

scripts/bump-version.sh (template only)

Manage template versions

File Locations

Path Purpose

.copier-answers/devops.yaml

Saved template answers

skaffold.yaml

Main Skaffold configuration

kubernetes/base/deployment.yaml

Base deployment with VAEC labels

kubernetes/components/dev/overrides.env

Dev environment configuration

kubernetes/site/overrides.env

Environment-specific configuration

Support