├── .github └── workflows │ └── lint.yml ├── Dockerfile ├── LICENSE ├── README.md ├── RELEASE.md ├── action.yaml └── entrypoint.sh /.github/workflows/lint.yml: -------------------------------------------------------------------------------- 1 | name: Lint Scripts 2 | on: [pull_request] 3 | permissions: 4 | contents: read 5 | jobs: 6 | shellcheck: 7 | name: Shellcheck 8 | runs-on: ubuntu-latest 9 | steps: 10 | - uses: actions/checkout@v2 11 | with: 12 | persist-credentials: false 13 | - uses: azohra/shell-linter@6bbeaa868df09c34ddc008e6030cfe89c03394a1 # v0.6.0 14 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM grafana/cortex-tools:v0.11.3 2 | 3 | COPY entrypoint.sh /entrypoint.sh 4 | 5 | ENTRYPOINT ["/entrypoint.sh"] 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright 2025 Grafana Labs 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Cortextool Github Action 2 | 3 | This action is used to lint, prepare, verify, diff, and sync rules to a [Cortex](https://github.com/cortexproject/cortex) cluster. 4 | 5 | ## Environment Variables 6 | 7 | This action is configured using environment variables defined in the workflow. The following variables can be configured. 8 | 9 | | Name | Description | Required | Default | 10 | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------- | ------- | 11 | | `CORTEX_ADDRESS` | URL address for the target Cortex cluster | `false` | N/A | 12 | | `CORTEX_TENANT_ID` | ID for the desired tenant in the target Cortex cluster. Used as the username under HTTP Basic authentication. | `false` | N/A | 13 | | `CORTEX_API_KEY` | Optional password that is required for password-protected Cortex clusters. An encrypted [github secret](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets ) is recommended. Used as the password under HTTP Basic authentication. | `false` | N/A | 14 | | `ACTION` | Which action to take. One of `lint`, `prepare`, `check`, `diff` or `sync` | `true` | N/A | 15 | | `RULES_DIR` | Comma-separated list of directories to walk in order to source rules files | `false` | `./` | 16 | | `LABEL_EXCLUDED_RULE_GROUPS` | Comma separated list of rule group names to exclude when including the configured label to aggregations. This option is supported only by the `prepare` action. | `false` | N/A | 17 | | `NAMESPACES` | Comma-separated list of namespaces to use | `false` | N/A | 18 | | `BACKEND` | Backend type to interact with: cortex, loki | `false` | `cortex` | 19 | 20 | ## Authentication 21 | 22 | This GitHub Action uses [`cortextool`](https://github.com/grafana/cortex-tools) under the hood, `cortextool` uses HTTP Basic authentication against a Cortex cluster. The variable `CORTEX_TENANT_ID` is used as the username and `CORTEX_API_KEY` as the password. 23 | 24 | ## Actions 25 | 26 | All actions will crawl the specified `RULES_DIR` for Prometheus rules and alerts files with a `yaml`/`yml` extension. 27 | 28 | ### `diff` 29 | 30 | Outputs the differences in the configured files and the currently configured ruleset in a Cortex cluster. It will output the required operations in order to make the running Cortex cluster match the rules configured in the directory. It will **not create/update/delete any rules** currently running in the Cortex cluster. 31 | 32 | ### `sync` 33 | 34 | Reconcile the differences with the sourced rules and the rules currently running in a configured Cortex cluster. It **will create/update/delete rules** currently running in Cortex to match what is configured in the files in the provided directory. 35 | 36 | ### `lint` 37 | 38 | Lints a rules file(s). The linter's aim is not to verify correctness but to fix YAML and PromQL expression formatting within the rule file(s). The linting happens in-place within the specified file(s). Does not interact with your Cortex cluster. 39 | 40 | ### `prepare` 41 | Prepares a rules file(s) for upload to Cortex. It lints all your PromQL expressions and adds a `cluster` label to your PromQL query aggregations in the file. Prepare modifies the file(s) in-place. Does not interact with your Cortex cluster. 42 | 43 | ### `check` 44 | 45 | Checks rules file(s) against the recommended [best practices](https://prometheus.io/docs/practices/rules/) for rules. Does not interact with your Cortex cluster. 46 | 47 | ### `print` 48 | 49 | fetch & print rules from the Cortex cluster. 50 | 51 | ## Outputs 52 | 53 | ### `summary` 54 | 55 | The `summary` output variable is a string denoting the output summary of the action, if there is one. 56 | 57 | ### `detailed` 58 | 59 | The `detailed` output variable returned by this action is the full output of the command executed. 60 | 61 | ## Example Workflows 62 | 63 | ### Pull Request Diff 64 | 65 | The following workflow will run a diff on every pull request against the repo and print the summary as a comment in the associated pull request: 66 | 67 | ```yaml 68 | name: diff_rules_pull_request 69 | on: [pull_request] 70 | jobs: 71 | diff-pr: 72 | runs-on: ubuntu-latest 73 | steps: 74 | - name: Checkout 75 | uses: actions/checkout@v2 76 | - name: Diff Rules 77 | id: diff_rules 78 | uses: grafana//cortex-rules-action@v0.1.1 79 | env: 80 | CORTEX_ADDRESS: https://example-cluster.com/ 81 | CORTEX_TENANT_ID: 1 82 | CORTEX_API_KEY: ${{ secrets.CORTEX_API_KEY }} # Encrypted Github Secret https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets 83 | ACTION: diff 84 | RULES_DIR: "./rules/" # In this example rules are stored in a rules directory in the repo 85 | - name: comment PR 86 | uses: unsplash/comment-on-pr@v1.2.0 # https://github.com/unsplash/comment-on-pr 87 | env: 88 | GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} 89 | with: 90 | msg: "${{ steps.diff_rules.outputs.summary }}" # summary could be replaced with detailed for a more granular view 91 | ``` 92 | 93 | ### Master Sync 94 | 95 | The following workflow will sync the rule files in the `master` branch with the configured Cortex cluster. 96 | 97 | ```yaml 98 | name: sync_rules_master 99 | on: 100 | push: 101 | branches: 102 | - master 103 | jobs: 104 | sync-master: 105 | runs-on: ubuntu-latest 106 | steps: 107 | - name: Checkout 108 | uses: actions/checkout@v2 109 | with: 110 | ref: master 111 | - name: sync-rules 112 | uses: grafana//cortex-rules-action@v0.1.1 113 | env: 114 | CORTEX_ADDRESS: https://example-cluster.com/ 115 | CORTEX_TENANT_ID: 1 116 | CORTEX_API_KEY: ${{ secrets.CORTEX_API_KEY }} # Encrypted Github Secret https://help.github.com/en/actions/automating-your-workflow-with-github-actions/creating-and-using-encrypted-secrets 117 | ACTION: sync 118 | RULES_DIR: "./rules/" # In this example rules are stored in a rules directory in the repo 119 | ``` 120 | -------------------------------------------------------------------------------- /RELEASE.md: -------------------------------------------------------------------------------- 1 | # Release processes 2 | 3 | 1. Update the `grafana/cortex-tools` image version in `Dockerfile` 4 | 2. Create a new tag that follows semantic versioning: 5 | 6 | ```bash 7 | $ tag=v0.6.0 8 | $ git tag -s "${tag}" -m "${tag}" 9 | $ git push origin "${tag}" 10 | ``` 11 | -------------------------------------------------------------------------------- /action.yaml: -------------------------------------------------------------------------------- 1 | name: cortextool-sync 2 | author: jtlisi 3 | description: "A set of actions to interact with Prometheus Rules files and a Cortex cluster." 4 | runs: 5 | using: "docker" 6 | image: "Dockerfile" 7 | outputs: 8 | summary: 9 | description: A summary of changes that will be made. 10 | detailed: 11 | description: A detailed description of changes that will be made. 12 | branding: 13 | icon: "upload" 14 | color: "blue" 15 | -------------------------------------------------------------------------------- /entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | # shellcheck shell=dash 3 | # 4 | # Interact with the Cortex Ruler API using the cortextool 5 | 6 | err() { 7 | echo "[$(date +'%Y-%m-%dT%H:%M:%S%z')]: " + "$@" >&2 8 | } 9 | 10 | # For commands that interact with the server, we need to verify that the 11 | # CORTEX_TENANT_ID and CORTEX_ADDRESS are set. 12 | verifyTenantAndAddress() { 13 | if [ -z "${CORTEX_TENANT_ID}" ]; then 14 | err "CORTEX_TENANT_ID has not been set." 15 | exit 1 16 | fi 17 | 18 | if [ -z "${CORTEX_ADDRESS}" ]; then 19 | err "CORTEX_ADDRESS has not been set." 20 | exit 1 21 | fi 22 | } 23 | 24 | LINT_CMD=lint 25 | CHECK_CMD=check 26 | PREPARE_CMD=prepare 27 | SYNC_CMD=sync 28 | DIFF_CMD="diff" 29 | PRINT_CMD=print 30 | 31 | if [ -z "${BACKEND}" ]; then 32 | echo "BACKEND not set, using 'cortex' as a default." 33 | BACKEND="cortex" 34 | fi 35 | 36 | if [ -z "${RULES_DIR}" ]; then 37 | echo "RULES_DIR not set, using './' as a default." 38 | RULES_DIR="./" 39 | fi 40 | 41 | if [ -z "${ACTION}" ]; then 42 | err "ACTION has not been set." 43 | exit 1 44 | fi 45 | 46 | case "${ACTION}" in 47 | "$SYNC_CMD") 48 | verifyTenantAndAddress 49 | OUTPUT=$(/usr/bin/cortextool rules sync --backend="${BACKEND}" --rule-dirs="${RULES_DIR}" ${NAMESPACES:+ --namespaces=${NAMESPACES}} "$@") 50 | STATUS=$? 51 | ;; 52 | "$DIFF_CMD") 53 | verifyTenantAndAddress 54 | OUTPUT=$(/usr/bin/cortextool rules diff --backend="${BACKEND}" --rule-dirs="${RULES_DIR}" ${NAMESPACES:+ --namespaces=${NAMESPACES}} --disable-color "$@") 55 | STATUS=$? 56 | ;; 57 | "$LINT_CMD") 58 | OUTPUT=$(/usr/bin/cortextool rules lint --backend="${BACKEND}" --rule-dirs="${RULES_DIR}" "$@") 59 | STATUS=$? 60 | ;; 61 | "$PREPARE_CMD") 62 | OUTPUT=$(/usr/bin/cortextool rules prepare --backend="${BACKEND}" -i --rule-dirs="${RULES_DIR}" --label-excluded-rule-groups="${LABEL_EXCLUDED_RULE_GROUPS}" "$@") 63 | STATUS=$? 64 | ;; 65 | "$CHECK_CMD") 66 | OUTPUT=$(/usr/bin/cortextool rules check --backend="${BACKEND}" --rule-dirs="${RULES_DIR}" "$@") 67 | STATUS=$? 68 | ;; 69 | "$PRINT_CMD") 70 | OUTPUT=$(/usr/bin/cortextool rules print --backend="${BACKEND}" --disable-color "$@") 71 | STATUS=$? 72 | ;; 73 | *) 74 | err "Unexpected action '${ACTION}'" 75 | exit 1 76 | ;; 77 | esac 78 | 79 | { echo "detailed<> "$GITHUB_OUTPUT" 80 | 81 | SUMMARY=$(echo "${OUTPUT}" | grep Summary) 82 | echo "summary=${SUMMARY}" >> "$GITHUB_OUTPUT" 83 | 84 | exit $STATUS 85 | --------------------------------------------------------------------------------