Validated Patterns

Workflow

Patterns are designed to be composed of multiple components, that consumers and contributors can integrate into GitOps workflows. For instance, the Industrial Edge pattern comprises a repository with pattern-specific logic and configuration, alongside a common repository containing elements common to various patterns. This common repository is included as a subtree within each pattern repository, streamlining consistency and reusability across different patterns.

Consuming a pattern

  1. Fork the pattern repository on GitHub to your workspace (GitHub user or organization). Forking is necessary because your fork updates as part of the GitOps and DevOps processes, and the main branch (by default) is used in the automated workflows.

  2. Clone the forked repository:

    git clone git@github.com:<your-workspace>/industrial-edge.git

  3. If you want to customize credentials, create a local copy of the secrets values file. Do not push the secrets file to GitHub.

    1. Create a local copy of the secrets template file:

      $ cp values-secret.yaml.template ~/values-secret.yaml
    2. Edit the file and securely add your cluster-specific credentials:

      $ vi ~/values-secret.yaml
  4. Customize the deployment for your cluster. Customization involves updating the values-global.yaml file with configurations specific to your cluster environment.

    1. Edit the values-global.yaml file:

      $ vi values-global.yaml
    2. Commit the updated values-global.yaml file to the repository:

      $ git commit values-global.yaml
    3. Push the committed changes:

      $ git push