Improve bitwarden example by imstevenxyz · Pull Request #3435 · external-secrets/external-secrets

imstevenxyz · 2024-04-29T20:36:59Z

Problem Statement

No specific problem

Related Issue

No related isssue

Proposed Changes

This PR improves the bitwarden example documentation by introducing a new (Cluster)SecretStore that is able to fetch attachments from Bitwarden. This is useful for fetching files like SSH keys for example. I also improved the grammar and spelling in the docs.

Checklist

I have read the contribution guidelines
All commits are signed with git commit --signoff
My changes have reasonable test coverage
All tests pass with make test
I ensured my PR is ready for review with make reviewable

Additional information

I could not run make docs.serve until I modified the mkdocs.yaml file. It had invalid keys that I also fixed in this PR.
Furthermore, I could not run make test or make reviewable as yq gives me the following error:

usage: yq [-h] [--yaml-output] [--yaml-roundtrip]
          [--yaml-output-grammar-version {1.1,1.2}] [--width WIDTH]
          [--indentless-lists] [--explicit-start] [--explicit-end]
          [--in-place] [--version]
          [jq_filter] [files ...]
yq: error: argument files: can't open '.spec.conversion.strategy = "Webhook" | .spec.conversion.webhook.conversionReviewVersions = ["v1"] | .spec.conversion.webhook.clientConfig.service.name = "kubernetes" | .spec.conversion.webhook.clientConfig.service.namespace = "default" |       .spec.conversion.webhook.clientConfig.service.path = "/convert"': [Errno 36] File name too long: '.spec.conversion.strategy = "Webhook" | .spec.conversion.webhook.conversionReviewVersions = ["v1"] | .spec.conversion.webhook.clientConfig.service.name = "kubernetes" | .spec.conversion.webhook.clientConfig.service.namespace = "default" |\t.spec.conversion.webhook.clientConfig.service.path = "/convert"'
make: *** [Makefile:136: generate] Error 2

Signed-off-by: Steven I. <commits@imsteven.xyz>

sonarqubecloud · 2024-04-29T20:37:25Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

gusfcarvalho · 2024-04-30T17:04:22Z

hi @imstevenxyz can you please sign your commits? This can be done with git commit --signoff flag

imstevenxyz · 2024-04-30T17:14:44Z

hi @imstevenxyz can you please sign your commits? This can be done with git commit --signoff flag

They are signed, I do not know why DCO is not picking up my name correctly.

gusfcarvalho · 2024-04-30T17:16:18Z

DCO verifies that your email is registered within your github alias (i.e. the account is bound to that email). If they differ, DCO would fail... perhaps thats it?

In any case, if you agree, I'll set it to pass manually. Are you OK with it?

imstevenxyz · 2024-04-30T17:20:09Z

Looks like Github/DCO is removing the trailing . from my name. It is all good, you can manually set it to pass. I opened an Issue on the DCO repo.

gusfcarvalho · 2024-04-30T18:04:18Z

thanks for your contribution @imstevenxyz

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [external-secrets](https://github.com/external-secrets/external-secrets) | patch | `0.9.16` -> `0.9.17` | --- ### Release Notes <details> <summary>external-secrets/external-secrets (external-secrets)</summary> ### [`v0.9.17`](https://github.com/external-secrets/external-secrets/releases/tag/v0.9.17) [Compare Source](external-secrets/external-secrets@v0.9.16...v0.9.17) Image: `ghcr.io/external-secrets/external-secrets:v0.9.17` Image: `ghcr.io/external-secrets/external-secrets:v0.9.17-ubi` Image: `ghcr.io/external-secrets/external-secrets:v0.9.17-ubi-boringssl` #### What's Changed - bump 0.9.16 by [@gusfcarvalho](https://github.com/gusfcarvalho) in external-secrets/external-secrets#3385 - Fix typo in webhook.md by [@Bo0km4n](https://github.com/Bo0km4n) in external-secrets/external-secrets#3388 - Publish the secret updated events only when they are updated by [@shuheiktgw](https://github.com/shuheiktgw) in external-secrets/external-secrets#3293 - Feat/add validations to external secret data from remote ref by [@shuheiktgw](https://github.com/shuheiktgw) in external-secrets/external-secrets#3390 - chore(deps): bump github/codeql-action from 3.24.10 to 3.25.1 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3406 - chore(deps): bump actions/checkout from 4.1.2 to 4.1.3 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3405 - chore(deps): bump regex from 2023.12.25 to 2024.4.16 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3404 - chore(deps): bump mkdocs-material from 9.5.17 to 9.5.18 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3402 - Fix Azure Container Registry Generator invalid YAML by [@ppatel1604](https://github.com/ppatel1604) in external-secrets/external-secrets#3414 - Update Go and golangci-lint version by [@shuheiktgw](https://github.com/shuheiktgw) in external-secrets/external-secrets#3396 - chore(deps): bump pymdown-extensions from 10.7.1 to 10.8 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3401 - ADOPTERS.md: add Fivetran by [@felipeneuwald](https://github.com/felipeneuwald) in external-secrets/external-secrets#3409 - Add Conjur Support for FindByName, FindByTag by [@szh](https://github.com/szh) in external-secrets/external-secrets#3364 - chore(deps): bump mkdocs from 1.5.3 to 1.6.0 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3403 - Add support for specifying extra manifests via helm by [@upodroid](https://github.com/upodroid) in external-secrets/external-secrets#3421 - Methods for managing securityContext and OpenShift support by [@sabre1041](https://github.com/sabre1041) in external-secrets/external-secrets#3420 - Refactor the SecretStore client manager by [@shuheiktgw](https://github.com/shuheiktgw) in external-secrets/external-secrets#3419 - chore(deps): bump golang from `cdc86d9` to `cdc86d9` by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3423 - chore(deps): bump golangci/golangci-lint-action from 4.0.0 to 5.0.0 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3425 - chore(deps): bump actions/checkout from 4.1.3 to 4.1.4 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3426 - chore(deps): bump github/codeql-action from 3.25.1 to 3.25.3 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3427 - chore(deps): bump helm/kind-action from 1.9.0 to 1.10.0 by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3428 - chore(deps): bump platformdirs from 4.2.0 to 4.2.1 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3429 - chore(deps): bump pymdown-extensions from 10.8 to 10.8.1 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3430 - chore(deps): bump regex from 2024.4.16 to 2024.4.28 in /hack/api-docs by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3431 - chore(deps): bump golang from `b03f3ba` to `d0902ba` in /e2e by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3432 - Update common-k8s-secret-types.md to fix get secret jsonpath by [@tyki6](https://github.com/tyki6) in external-secrets/external-secrets#3434 - chore: update dependencies by [@eso-service-account-app](https://github.com/eso-service-account-app) in external-secrets/external-secrets#3433 - chore(deps): bump distroless/static from `6d31326` to `4197211` by [@dependabot](https://github.com/dependabot) in external-secrets/external-secrets#3424 - Improve bitwarden example by [@imstevenxyz](https://github.com/imstevenxyz) in external-secrets/external-secrets#3435 #### New Contributors - [@Bo0km4n](https://github.com/Bo0km4n) made their first contribution in external-secrets/external-secrets#3388 - [@felipeneuwald](https://github.com/felipeneuwald) made their first contribution in external-secrets/external-secrets#3409 - [@upodroid](https://github.com/upodroid) made their first contribution in external-secrets/external-secrets#3421 - [@sabre1041](https://github.com/sabre1041) made their first contribution in external-secrets/external-secrets#3420 - [@tyki6](https://github.com/tyki6) made their first contribution in external-secrets/external-secrets#3434 - [@imstevenxyz](https://github.com/imstevenxyz) made their first contribution in external-secrets/external-secrets#3435 **Full Changelog**: external-secrets/external-secrets@v0.9.16...v0.9.17 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Reviewed-on: https://git.internal/nrdufour/home-ops/pulls/460 Co-authored-by: Renovate <renovate@ptinem.casa> Co-committed-by: Renovate <renovate@ptinem.casa>

* Add bitwarden-attachment example Signed-off-by: Steven I. <commits@imsteven.xyz> * Fix nav list Signed-off-by: Steven I. <commits@imsteven.xyz> --------- Signed-off-by: Steven I. <commits@imsteven.xyz> Signed-off-by: Bude8 <henryblee8@gmail.com>

* Add bitwarden-attachment example Signed-off-by: Steven I. <commits@imsteven.xyz> * Fix nav list Signed-off-by: Steven I. <commits@imsteven.xyz> --------- Signed-off-by: Steven I. <commits@imsteven.xyz> Signed-off-by: Bill Hamilton <bill.hamilton@delinea.com>

imstevenxyz added 2 commits April 29, 2024 22:24

Add bitwarden-attachment example

24ccdc8

Signed-off-by: Steven I. <commits@imsteven.xyz>

Fix nav list

3985271

Signed-off-by: Steven I. <commits@imsteven.xyz>

imstevenxyz requested a review from a team as a code owner April 29, 2024 20:37

imstevenxyz requested a review from gusfcarvalho April 29, 2024 20:37

gusfcarvalho approved these changes Apr 30, 2024

View reviewed changes

gusfcarvalho merged commit 297e55d into external-secrets:main Apr 30, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve bitwarden example#3435

Improve bitwarden example#3435
gusfcarvalho merged 2 commits intoexternal-secrets:mainfrom
imstevenxyz:bitwarden-attachments-docs

imstevenxyz commented Apr 29, 2024

Uh oh!

sonarqubecloud bot commented Apr 29, 2024

Uh oh!

gusfcarvalho commented Apr 30, 2024

Uh oh!

imstevenxyz commented Apr 30, 2024

Uh oh!

gusfcarvalho commented Apr 30, 2024 •

edited

Loading

Uh oh!

imstevenxyz commented Apr 30, 2024 •

edited

Loading

Uh oh!

gusfcarvalho commented Apr 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

imstevenxyz commented Apr 29, 2024

Problem Statement

Related Issue

Proposed Changes

Checklist

Additional information

Uh oh!

sonarqubecloud bot commented Apr 29, 2024

Quality Gate passed

Uh oh!

gusfcarvalho commented Apr 30, 2024

Uh oh!

imstevenxyz commented Apr 30, 2024

Uh oh!

gusfcarvalho commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

imstevenxyz commented Apr 30, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

gusfcarvalho commented Apr 30, 2024

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

gusfcarvalho commented Apr 30, 2024 •

edited

Loading

imstevenxyz commented Apr 30, 2024 •

edited

Loading