jabbermouth/demo repository overview

⁠Demo Projects

This project is simple demo project intended for testing containers. It includes support for reading in a config file, an environment variable and also includes basic healthcheck functionality.

⁠Versioning

The project contains many tags that have been used to build containers with a range of tags (SemVer formatting) to allow testing of various release strategies. A corresponding Helm Chart is also available.

Versions available are:

• 0.0.1-alpha
• 0.0.1-alpha+123
• 0.0.1-alpha+456
• 0.0.1-alpha+1234
• 0.0.1
• 0.0.1+123
• 0.0.2
• 0.0.3-alpha
• 0.0.3
• 0.1.0-alpha
• 0.1.0
• 0.1.1
• 1.0.0-alpha
• 1.0.0-beta
• 1.0.0-rc1
• 1.0.0-rc2
• 1.0.0
• 1.1.0
• 2.0.0-alpha
• 2.0.0-beta
• 2.0.0-rc1
• 2.0.0
• 2.0.1-alpha

Additional tagging:

• 2.0.1-alpha is also tagged as alpha
• 2.0.0 is also tagged as latest
• 1.1.0 is also tagged as v1-latest
• 2.0.0 is also tagged as v2-latest

⁠Health Checks

/healthz/ - heartbeat check + is a test file present /healthz/kubernetes/ - heartbeat check

⁠End Points

/makeunhealthy/normal - will make the basic healthcheck return unhealthy but not the Kubernetes one /makeunhealthy/k8s - will make the basic and kubernetes healthchecks return unhealthy

⁠Config File Entries

/app/required.json - a mandatory JSON file that is included in the container image but can be overriden

{
  "Required": {
    "MyValue": "Original required file value"
  }
}

/app/optional.json - an optional JSON file that isn't included in the container image

{
  "Optional": {
    "MyValue": "Your value"
  }
}

⁠Environment Variables

BASE_URL - if running the application anywhere other than the root of a domain, pass in the base URL that the site is deployed to (e.g. for a site running at "https://www.mydomain.com/mysite/⁠", pass in "/mysite") CanBeOverridden__HasDefault - a value already specified in the main appsettings.json file CanBeOverridden__OnlyFromEnvVar - a value not already in the main appsettings.json file that can be injected at runtime via an environment variable

⁠Output

Going to the root of the site will output links and the values of the various config entries above as well the current version.