This repository wraps the environment information action, allowing it to be used as a replacement in support of various string functions and namespace standardization.

This project is part of our comprehensive "SweetOps" approach towards DevOps.

It's 100% Open Source and licensed under the APACHE2.

We often find when deploying with various environments that we need to standardize the namespace names. This repository wraps the environment information action, allowing it to be used as a replacement in support of various string functions and namespace standardization.

With this action, you can use pipe functions to standardize the namespace names, for example, to lowercase, or to replace a dash with an underscore you can use | kebabcase or | toLower

To use this action, you'll want to create a workflow and argocd repository. This action is intended to replace cloudposse/github-action-yaml-config-query by wrapping it with helper actions.

With this action your config input can have several helper functions.

• reformat this replaces the namespace with a flavor of your choice. this is a key added to an environments configuration. See snipped below for example
  • branch-name will use the branch name as the namespace
  • pr-number will use the PR number as the namespace
• | functions: you can now perform simple string operations on keys in your environment configuration. This can help prevent dns invalid characters from becoming your namespace based on the branch name.
  • | kebabcase will convert the string to kebabcase (alternatively you can use | toKebab or | kebab)
  • | lowercase will convert the string to lowercase (alternatively you can use | toLower or | lower)
  • | uppercase will convert the string to uppercase (alternatively you can use | toUpper or | upper) Though this is perhaps less helpful as it is not valid in kubernetes nor dns.

- name: Environment info
  # We recommend pinning this action to a specific release or version range to ensure stability
  uses: cloudposse/github-action-kubernetes-environment@main
  id: result
  with:
    environment: ${{ inputs.environment }}
    namespace: ${{ inputs.namespace }}
    application: ${{ inputs.application }}
    config: |
      preview:
        cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-dev/apps
        cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
        namespace: ${{ inputs.namespace }}
        reformat: branch-name # reformats namespace to be branch name as kebabcase, alternatively use `pr-number` here for `pr-123` as your namespace
        ssm-path: platform/dev-cluster
      qa1:
        cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
        cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
        namespace: QA1/MY-APP | kebabcase
        # output namespace will become qa1-my-app
        ssm-path: platform/staging-cluster

• To get custom key value pairs you can query the selected environment with a follow up step:

- name: Environment info
uses: cloudposse/github-action-yaml-config-query@0.1.0
id: environment-info
with:
  query: .
  config: ${{ steps.result.outputs.environment-config }}

name: 'Environments - ArgoCD'
description: 'Get information about environment'
inputs:
  environment:
    description: "Environment name"
    required: true
  application:
    description: "The application name"
    required: false
  namespace:
    description: "Namespace name"
    required: true
outputs:
  name:
    description: "Environment name"
    value: ${{ inputs.environment }}
  region:
    description: "Default AWS Region"
    value: us-east-2
  role:
    description: "Environments that need to be deployed"
    value: ${{ steps.result.outputs.role }}
  cluster:
    description: "Environments that need to be destroyed"
    value: ${{ steps.result.outputs.cluster }}
  namespace:
    description: "Namespace"
    value: ${{ steps.result.outputs.namespace }}
  ssm-path:
    description: "Path to ssm secrets"
    value: ${{ steps.result.outputs.ssm-path }}

runs:
  using: "composite"
  steps:
    - name: Environment info
      # We recommend pinning this action to a specific release or version range to ensure stability
      uses: cloudposse/github-action-kubernetes-environment@main
      id: result
      with:
        environment: ${{ inputs.environment }}
        namespace: ${{ inputs.namespace }}
        application: ${{ inputs.application }}
        config: |
          preview:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-dev/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: ${{ inputs.namespace }}
            ssm-path: platform/dev-cluster
            reformat: branch-name
          qa1:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: qa1
            ssm-path: platform/staging-cluster
          qa2:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: qa2
            ssm-path: platform/staging-cluster
          qa3:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: qa3
            ssm-path: platform/staging-cluster
          qa4:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: qa4
            ssm-path: platform/staging-cluster
          
          production:
            cluster: https://github.com/athoteldev/argocd-deploy-prod/blob/main/plat/ue2-prod/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: production
            ssm-path: platform/prod-cluster
          
          staging:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-staging/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: staging
            ssm-path: platform/staging-cluster
          
          sandbox:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-sandbox/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: sandbox
            ssm-path: platform/sandbox-cluster

          dev:
            cluster: https://github.com/cloudposse/argocd-repo/blob/main/plat/ue2-dev/apps
            cluster-role: arn:aws:iam::123456789012:role/my-gha-cluster-role
            namespace: dev  
            ssm-path: platform/dev-cluster

Like this project? Please give it a ★ on our GitHub! (it helps us a lot)

Are you using this project or any of our other projects? Consider leaving a testimonial. =)

Check out these related projects.

For additional context, refer to some of these links.

• github-actions-workflows - Reusable workflows for different types of projects
• example-github-action-release-workflow - Example application with complicated release workflow

Got a question? We got answers.

File a GitHub issue, send us an email or join our Slack Community.

We are a DevOps Accelerator. We'll help you build your cloud infrastructure from the ground up so you can own it. Then we'll show you how to operate it and stick around for as long as you need us.

Work directly with our team of DevOps experts via email, slack, and video conferencing.

We deliver 10x the value for a fraction of the cost of a full-time engineer. Our track record is not even funny. If you want things done right and you need it done FAST, then we're your best bet.

• Reference Architecture. You'll get everything you need from the ground up built using 100% infrastructure as code.
• Release Engineering. You'll have end-to-end CI/CD with unlimited staging environments.
• Site Reliability Engineering. You'll have total visibility into your apps and microservices.
• Security Baseline. You'll have built-in governance with accountability and audit logs for all changes.
• GitOps. You'll be able to operate your infrastructure via Pull Requests.
• Training. You'll receive hands-on training so your team can operate what we build.
• Questions. You'll have a direct line of communication between our teams via a Shared Slack channel.
• Troubleshooting. You'll get help to triage when things aren't working.
• Code Reviews. You'll receive constructive feedback on Pull Requests.
• Bug Fixes. We'll rapidly work with you to fix any bugs in our projects.

Join our Open Source Community on Slack. It's FREE for everyone! Our "SweetOps" community is where you get to talk with others who share a similar vision for how to rollout and manage infrastructure. This is the best place to talk shop, ask questions, solicit feedback, and work together as a community to build totally sweet infrastructure.

Participate in our Discourse Forums. Here you'll find answers to commonly asked questions. Most questions will be related to the enormous number of projects we support on our GitHub. Come here to collaborate on answers, find solutions, and get ideas about the products and services we value. It only takes a minute to get started! Just sign in with SSO using your GitHub account.

Sign up for our newsletter that covers everything on our technology radar. Receive updates on what we're up to on GitHub as well as awesome new projects we discover.

Join us every Wednesday via Zoom for our weekly "Lunch & Learn" sessions. It's FREE for everyone!

Please use the issue tracker to report any bugs or file feature requests.

If you are interested in being a contributor and want to get involved in developing this project or help out with our other projects, we would love to hear from you! Shoot us an email.

In general, PRs are welcome. We follow the typical "fork-and-pull" Git workflow.

1. Fork the repo on GitHub
2. Clone the project to your own machine
3. Commit changes to your own branch
4. Push your work back up to your fork
5. Submit a Pull Request so that we can review your changes

NOTE: Be sure to merge the latest changes from "upstream" before making a pull request!

Copyright © 2017-2023 Cloud Posse, LLC

See LICENSE for full details.

Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements.  See the NOTICE file
distributed with this work for additional information
regarding copyright ownership.  The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License.  You may obtain a copy of the License at

  https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied.  See the License for the
specific language governing permissions and limitations
under the License.

All other trademarks referenced herein are the property of their respective owners.

This project is maintained and funded by Cloud Posse, LLC. Like it? Please let us know by leaving a testimonial!

We're a DevOps Professional Services company based in Los Angeles, CA. We ❤️ Open Source Software.

We offer paid support on all of our projects.

Check out our other projects, follow us on twitter, apply for a job, or hire us to help with your cloud strategy and implementation.

Benjamin Smith