Amazon App Mesh Virtual Gateway Route Action for GitHub Actions
MIT License
Creates an Amazon App Mesh Virtual Gateway Route
Table of Contents
- name: App Mesh Virtual Gateway Route
uses: scribd/amazon-appmesh-virtual-gateway-route-action@v1
with:
name: my-virtual-route-name
mesh-name: my-mesh-name
virtual-gateway-name: appmesh-gateway.example.com
mesh-owner: 0123456789
spec: |
{
"httpRoute": {
"action": {
"target": {
"virtualService": {
"virtualServiceName": "my-virtual-service.my-mesh.example.com"
}
},
"rewrite": {
"hostname": {
"defaultTargetHostname": "DISABLED"
}
}
},
"match": {
"hostname": {
"exact": "my-virtual-service.my-mesh.example.com"
}
}
}
}
tags: |
[
{
"key": "tags-must",
"value": "be-passed-in-as-a-json-string"
},
{
"key": "this-is-because",
"value": "GitHub Actions translates these values into Environment Variables"
}
]
Deleting the resource requires name
, mesh-name
, virtual-gateway-name
, and action
to be specified as delete
. mesh-owner
may be supplied if required. Any additional parameters will be ignored.
- name: App Mesh Virtual Gateway Route
uses: scribd/amazon-appmesh-virtual-gateway-route-action@v1
with:
name: my-virtual-route-name
mesh-name: my-mesh-name
virtual-gateway-name: appmesh-gateway.example.com
action: delete
See action.yml for the full documentation for this action's inputs and outputs.
This action relies on the default behavior of the AWS SDK for Javascript to determine AWS credentials and region.
Use the aws-actions/configure-aws-credentials
action to configure the GitHub Actions environment with environment variables containing AWS credentials and your desired region.
We recommend following Amazon IAM best practices for the AWS credentials used in GitHub Actions workflows, including:
This action requires the following minimum set of permissions:
{
"Version":"2012-10-17",
"Statement":[
{
"Sid":"DeployService",
"Effect":"Allow",
"Action":[
"appmesh:DescribeGatewayRoute",
"appmesh:DeleteGatewayRoute",
"appmesh:CreateGatewayRoute"
],
"Resource":[
"arn:aws:appmesh:us-east-1:1234567890:mesh/my-mesh-name/**/*"
]
}
]
}
This action emits debug logs to help troubleshoot deployment failures. To see the debug logs, create a secret named ACTIONS_STEP_DEBUG
with value true
in your repository.
To run this action from your workstation, you should supply your environment variables with the env
command, since BASH will (correctly) refuse to set environment variables with dashes in them.
If submitting an issue, please include output styled after the following example, it'll help greatly! Don't forget to redact any sensitive data from your submission.
See this example:
env 'ACTIONS_STEP_DEBUG=true' "GITHUB_WORKSPACE=$(pwd)" 'AWS_REGION=us-east-1' 'INPUT_SPEC={"a": "b", "c": [{"d": "e"}]}' 'INPUT_MESH-NAME=example-mesh' 'INPUT_NAME=my-service' 'INPUT_TAGS=[{"Key": "hello", "Value": "world"}]' node index.js
Releases are cut using semantic-release.
Please write commit messages following Angular commit guidelines