diff --git a/.github/workflows/pr-check.yaml b/.github/workflows/pr-check.yaml index b29b8ab..b6ba248 100644 --- a/.github/workflows/pr-check.yaml +++ b/.github/workflows/pr-check.yaml @@ -5,11 +5,92 @@ on: branches: [main] permissions: + actions: read + checks: write contents: read + pull-requests: read + security-events: write jobs: build-and-test: - uses: kedify/github-meta/.github/workflows/go-pr-check.yaml@c9332258ab5bbe61f19115c3b4542fe18ff747fb - with: - continue_on_error: false - skip_private_key_setup: true + name: Run PR Checks + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7 + with: + fetch-depth: 0 + + - name: Set up Go + uses: actions/setup-go@924ae3a1cded613372ab5595356fb5720e22ba16 # v6 + with: + go-version-file: go.mod + + - name: Verify dependencies + run: | + set -euo pipefail + go mod verify + go mod tidy + gofmt -s -w . + if [[ -n "$(git status --porcelain)" ]]; then + echo "dirty repository" + git status + exit 1 + fi + + - name: Run go vet + run: go vet ./... + + - name: Run golangci-lint + uses: golangci/golangci-lint-action@82606bf257cbaff209d206a39f5134f0cfbfd2ee # v9.2.1 + with: + version: v2.12.2 + args: --timeout=10m + + - name: Run staticcheck + uses: dominikh/staticcheck-action@9716614d4101e79b4340dd97b10e54d68234e431 # v1 + with: + version: v0.8.0 + install-go: false + + - name: Run vulncheck + run: | + go install golang.org/x/vuln/cmd/govulncheck@v1.6.0 + echo -e "### vulncheck\n\n" >> "$GITHUB_STEP_SUMMARY" + echo '```' >> "$GITHUB_STEP_SUMMARY" + (govulncheck -scan package ./... || true) | tee -a "$GITHUB_STEP_SUMMARY" + echo '```' >> "$GITHUB_STEP_SUMMARY" + + - name: Run Gosec Security Scanner + uses: securego/gosec@bb17e422fc34bf4c0a2e5cab9d07dc45a68c040c # v2.24.7 + with: + args: '-no-fail -fmt sarif -out results.sarif ./...' + + - name: Normalize SARIF for GitHub upload + run: | + jq ' + (.runs[]?.tool.driver.rules[]?) |= + (if has("relationships") then + if (.relationships | type) == "array" then + .relationships |= map(select(type == "object")) + else + del(.relationships) + end + else + . + end) + ' results.sarif > results.normalized.sarif + mv results.normalized.sarif results.sarif + + - name: Upload SARIF file + uses: github/codeql-action/upload-sarif@cdf488f595d80d6e07e03d4674febd5ab45fa938 # v4 + with: + sarif_file: results.sarif + + - name: Build + env: + CGO_ENABLED: 0 + run: make build + + - name: Test + run: make test diff --git a/.github/workflows/repo-backup-template.yml b/.github/workflows/repo-backup-template.yml new file mode 100644 index 0000000..43477ad --- /dev/null +++ b/.github/workflows/repo-backup-template.yml @@ -0,0 +1,110 @@ +# Reusable template workflow for backing up repositories to Google Cloud Storage +# SOC 2 Compliance: Complete git repository backup using bare mirror clone preserving all branches, tags, and history +# Required workflow-call secrets: GH_TOKEN (repository token) and GCP_SA_KEY (service account JSON key) + +############################################################################################# +# WARNING: +# UPDATE THIS FILE ONLY in kedify/github-meta/.github/workflows/repo-backup-template.yml +# +# Copy paste this file if needed to run from a public repo. +############################################################################################ + +name: "Repo Backup: backup repo to GCS" + +on: + workflow_call: + inputs: + bucket: + description: "GCS bucket name for backup storage (e.g. kedify-github-backups)" + required: true + type: string + secrets: + GH_TOKEN: + description: "Token used to clone the repository (map from caller's secrets.GITHUB_TOKEN or a PAT)" + required: true + GCP_SA_KEY: + description: "GCP Service Account JSON key for authentication" + required: true + +permissions: + contents: read + +jobs: + backup: + runs-on: ubuntu-latest + steps: + - name: Authenticate to Google Cloud + uses: google-github-actions/auth@7c6bc770dae815cd3e89ee6cdf493a5fab2cc093 # v3 + with: + credentials_json: ${{ secrets.GCP_SA_KEY }} + + - name: Setup Google Cloud SDK + uses: google-github-actions/setup-gcloud@aa5489c8933f4cc7a4f7d45035b3b1440c9c10db # v3 + + - name: Verify required tools + run: | + set -euo pipefail + echo "Verifying required tools..." + command -v git >/dev/null || { echo "git not found"; exit 1; } + command -v tar >/dev/null || { echo "tar not found"; exit 1; } + command -v gsutil >/dev/null || { echo "gsutil not found"; exit 1; } + echo "All required tools available" + + - name: Create git mirror backup + run: | + set -euo pipefail + DATE=$(date +%F) + REPO_FULL="${{ github.repository }}" + SANITIZED_REPO="${REPO_FULL//\//_}" + ARCHIVE_NAME="${SANITIZED_REPO}-${DATE}-${GITHUB_RUN_ID}.tar.gz" + echo "ARCHIVE_NAME=${ARCHIVE_NAME}" >> "$GITHUB_ENV" + + TEMP_DIR=$(mktemp -d) + trap 'rm -rf "$TEMP_DIR" 2>/dev/null || true' EXIT + cd "$TEMP_DIR" + + git config --global url."https://x-access-token:${{ secrets.GH_TOKEN }}@github.com/".insteadOf "https://github.com/" + git clone --mirror "https://github.com/${{ github.repository }}" repo.git + + tar -czf "${ARCHIVE_NAME}" repo.git/ + mv "${ARCHIVE_NAME}" "${GITHUB_WORKSPACE}/${ARCHIVE_NAME}" + ls -lh "${GITHUB_WORKSPACE}/${ARCHIVE_NAME}" + echo "✓ Git mirror backup created" + + - name: Upload backup to GCS (daily + monthly snapshot handling) + shell: bash + env: + ARCHIVE_NAME: ${{ env.ARCHIVE_NAME }} + run: | + set -euo pipefail + ORG="${{ github.repository_owner }}" + REPO_NAME=$(basename "${{ github.repository }}") + BUCKET="${{ inputs.bucket }}" + + DAILY_PATH="gs://${BUCKET}/daily/${ORG}/${REPO_NAME}/" + MONTHLY_PATH="gs://${BUCKET}/monthly/${ORG}/${REPO_NAME}/" + + echo "Uploading ${GITHUB_WORKSPACE}/${ARCHIVE_NAME} -> ${DAILY_PATH}" + gsutil cp "${GITHUB_WORKSPACE}/${ARCHIVE_NAME}" "${DAILY_PATH}" + + if gsutil -q stat "${DAILY_PATH}${ARCHIVE_NAME}"; then + echo "✓ Daily backup uploaded: ${DAILY_PATH}${ARCHIVE_NAME}" + else + echo "✗ Failed to validate daily upload" + gsutil ls -l "${DAILY_PATH}" + exit 1 + fi + + DAY_OF_MONTH=$(date +%d) + if [ "$DAY_OF_MONTH" = "01" ]; then + echo "First of month — creating monthly snapshot copy -> ${MONTHLY_PATH}" + gsutil cp "${GITHUB_WORKSPACE}/${ARCHIVE_NAME}" "${MONTHLY_PATH}" + + if gsutil -q stat "${MONTHLY_PATH}${ARCHIVE_NAME}"; then + echo "✓ Monthly snapshot uploaded: ${MONTHLY_PATH}${ARCHIVE_NAME}" + else + echo "✗ Failed to validate monthly snapshot upload" + gsutil ls -l "${MONTHLY_PATH}" + exit 1 + fi + fi diff --git a/.github/workflows/repo-backup.yml b/.github/workflows/repo-backup.yml index 0e3e535..24aedfe 100644 --- a/.github/workflows/repo-backup.yml +++ b/.github/workflows/repo-backup.yml @@ -3,7 +3,7 @@ # Triggers daily at 02:00 UTC, supports manual dispatch for testing ############################################################################################# -# WARNING: +# WARNING: # UPDATE THIS FILE ONLY in kedify/github-meta/.github/workflows/repo-backup.yml # # THE ONLY EXCEPTION is the PRIVATE / PUBLIC REPO distinction below. @@ -21,9 +21,9 @@ on: jobs: backup: # PRIVATE REPOS: Reuse the backup workflow defined in the github-meta repo - uses: kedify/github-meta/.github/workflows/repo-backup-template.yml@main + # uses: kedify/github-meta/.github/workflows/repo-backup-template.yml@main # PUBLIC REPOS: Copy and reference the template from github-meta repo directly here - # uses: ./.github/workflows/repo-backup-template.yml + uses: ./.github/workflows/repo-backup-template.yml with: bucket: kedify-github-backups secrets: diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed 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 + + http://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. diff --git a/README.md b/README.md index 80f3535..42a61a7 100644 --- a/README.md +++ b/README.md @@ -1,30 +1,45 @@ # Kedify Recommender -This private Go module contains the pure resource recommendation calculations shared -by Kedify services. It does not query metrics, call Kubernetes, serve HTTP, or store -recommendations. +This Go module contains the resource recommendation calculations shared by Kedify +services and the Kedify CLI. It does not query metrics, call Kubernetes, serve +HTTP, or store recommendations. -The `analysis` package accepts normalized per-container observations and a policy. It -returns deterministic CPU and memory request/limit recommendations together with the -evidence and data quality used to produce them. - -Input/output schema versions describe the wire shape. The separate detector and -effective-policy versions preserve recommendation identity across callers. +The `analysis` package accepts normalized per-container observations and a policy. +It returns deterministic CPU and memory request/limit recommendations together +with the evidence and data quality used to produce them. ```go +import "github.com/kedify/recommender/analysis" + output, err := analysis.Analyze(snapshot, policy) ``` -Callers are responsible for collecting and aggregating observations. In particular, -CPU `max` or `percentile` selection happens in the caller's metrics query or snapshot -adapter; the normalized `aggregatedUsage` value must match the supplied policy. +Callers are responsible for collecting and aggregating observations. In +particular, CPU `max` or `percentile` selection happens in the caller's metrics +query or snapshot adapter; the normalized `aggregatedUsage` value must match the +supplied policy. + +Input/output schema versions describe the data shape. The detector and effective +policy versions preserve recommendation identity across callers. Consumers should +pin a released module version and reject unsupported schemas instead of converting +legacy input. + +## Consumers + +- [`dashboard-api-service`](https://github.com/kedify/dashboard-api-service) + adapts stored Kedify telemetry or Prometheus-compatible results to normalized + input. +- [`kedify/cli`](https://github.com/kedify/cli) links the same package for local + and air-gapped analysis. + +## Development + +Run the tests with: + +```sh +go test ./... +``` -## Distribution +## License -- `dashboard-api-service` imports this module and adapts stored Kedify telemetry or - Prometheus-compatible results to the normalized input. -- Private offline components may import the same module. -- The public [`kedify/cli`](https://github.com/kedify/cli) remains an API/results - client and does not embed this private engine. -- Offline packaging is tracked by - [`kedify/agent#618`](https://github.com/kedify/agent/issues/618). +Licensed under the Apache License, Version 2.0. See [LICENSE](LICENSE).