{"id":24994185,"url":"https://github.com/argyle-engineering/ksops","last_synced_at":"2025-04-12T03:03:11.529Z","repository":{"id":40356019,"uuid":"418259807","full_name":"argyle-engineering/ksops","owner":"argyle-engineering","description":"A Flexible KRM based Kustomize Plugin for SOPS Encrypted Secrets.","archived":false,"fork":false,"pushed_at":"2024-06-27T07:13:56.000Z","size":164,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-06-27T08:31:53.550Z","etag":null,"topics":["krm","kustomize","plugin","sops"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/argyle-engineering.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-10-17T21:28:17.000Z","updated_at":"2024-06-27T07:13:58.000Z","dependencies_parsed_at":"2023-11-06T14:41:09.517Z","dependency_job_id":"287b71ad-4263-43e9-a8cc-32e6d2137a60","html_url":"https://github.com/argyle-engineering/ksops","commit_stats":null,"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argyle-engineering%2Fksops","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argyle-engineering%2Fksops/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argyle-engineering%2Fksops/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/argyle-engineering%2Fksops/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/argyle-engineering","download_url":"https://codeload.github.com/argyle-engineering/ksops/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237135285,"owners_count":19260842,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["krm","kustomize","plugin","sops"],"created_at":"2025-02-04T14:39:51.731Z","updated_at":"2025-02-04T14:39:52.586Z","avatar_url":"https://github.com/argyle-engineering.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# KSOPS\n\n[![CI Status](https://github.com/argyle-engineering/ksops/actions/workflows/ci.yaml/badge.svg)](https://github.com/argyle-engineering/ksops/actions/workflows/ci.yaml)\n\nKSOPS is a flexible Kustomize KRM-based plugin for SOPS encrypted resources. This repository provides a completely new KRM-based plugin with no affiliation with the existing Go-based ksops plugin.\n\n## Features\n\n- A flexible Kustomize KRM-based plugin for SOPS encrypted resources.\n- Provides the ability to fail silently if the generator fails to decrypt files.\n- Generates dummy secrets with the `KSOPS_GENERATE_DUMMY_SECRETS` environment variable.\n- Example files and PGP key are provided with the repository to test KSOPS.\n\n## Installation\n\nTo install KSOPS, download the binary and add it to your path.\n\nTL;DR\n\nFor MacOS Arm64:\n\n```shell\nexport BINARY_PATH=~/go/bin/\n\ngh release download --clobber -R argyle-engineering/ksops --pattern ksops_Darwin_arm64.tar.gz \u0026\u0026 mkdir ksops \u0026\u0026 tar -xzvf ksops_Darwin_arm64.tar.gz -C ksops \u0026\u0026 chmod +x ksops/ksops \u0026\u0026 mv ksops/ksops $BINARY_PATH \u0026\u0026 rm -r ksops/ ksops_Darwin_arm64.tar.gz\n```\n\n## Usage\n\nTo use KSOPS example, follow these steps:\n\n1. Import the GPG key: `gpg --import example/sops_functional_tests_key.asc`.\n2. Build and decrypt the example files: `kustomize build --enable-alpha-plugins --enable-exec example/`.\n\nTo generate dummy secrets, set the `KSOPS_GENERATE_DUMMY_SECRETS` environment variable to `true`. For example: `KSOPS_GENERATE_DUMMY_SECRETS=TRUE kustomize build --enable-alpha-plugins \u003cdir\u003e`.\n\nTo allow KSOPS to fail silently, add the following to the generator:\n\n```yaml\napiVersion: argyle.com/v1\nkind: ksops\nmetadata:\n  name: secret-generator\n  annotations:\n    config.kubernetes.io/function: |2-\n      exec:\n        path: ksops  \nfail-silently: true\nfiles:\n- ./secret.enc.yaml\n```\n\n## Release Process\n\nTo release a new version, install `goreleaser` and set your GitHub token:\n\n```shell\nbrew install goreleaser syft \nexport GITHUB_TOKEN=\"YOUR_GH_TOKEN\"\n```\n\nThen, create a tag and push it to GitHub:\n\n```shell\ngit tag -a v0.1.0\ngit push origin v0.1.0\n```\n\nFinally, run the following command:\n\n```shell\ngoreleaser release\n```\n\nor use docker \n\n```shell\ndocker buildx build --platform linux/arm64,linux/amd64 -t ksops:v1.0.3 --push .\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fargyle-engineering%2Fksops","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fargyle-engineering%2Fksops","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fargyle-engineering%2Fksops/lists"}