Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

bump appVersion to 0.3.0 #75

Merged
merged 3 commits into from
Nov 8, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci-helm-lint-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,8 @@ jobs:

- name: Pull and side-load docker container
run: |
docker pull --platform=linux/amd64 docker.io/jessebot/bweso:v0.2.0 && \
kind load docker-image docker.io/jessebot/bweso:v0.2.0 --name kind-chart-testing
docker pull --platform=linux/amd64 docker.io/jessebot/bweso:v0.3.0 && \
kind load docker-image docker.io/jessebot/bweso:v0.3.0 --name kind-chart-testing
shell: bash

- name: Run chart-testing (install)
Expand Down
116 changes: 115 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,122 @@
property: password
```

## Testing

Searching for items has to be done using JSONpath, you will need to install a utility for that, we use [bashtools/JSONPath.sh](https://github.com/bashtools/JSONPath.sh).

To query the endpoint you will need to deploy a maintenance container into the `external-secrets` namespace.

```yaml
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: maintenance
namespace: external-secrets
annotations:
# set to "true" to include in future backups
k8up.io/backup: "false"
# Optional:
#labels:
# app: multi-file-writer
spec:
# Optional:
storageClassName: local-path
accessModes:
- ReadWriteOnce
resources:
requests:
# Must be sufficient to hold your data
storage: 16Gi
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: maintenance
namespace: external-secrets
annotations:
# set to "true" to include in future backups
k8up.io/backup: "false"
# Optional:
#labels:
# app: multi-file-writer
spec:
# Optional:
storageClassName: local-path
accessModes:
- ReadWriteOnce
resources:
requests:
# Must be sufficient to hold your data
storage: 16Gi
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: maintenance
namespace: external-secrets
spec:
selector:
matchLabels:
app: onboardme
template:
metadata:
labels:
app: onboardme
spec:
restartPolicy: Always
containers:
- name: onboardme
image: jessebot/onboardme:debian12
command:
- /bin/sleep
- 3650d
imagePullPolicy: IfNotPresent
ports:
- containerPort: 80
name: "http"
- containerPort: 443
name: "https"
- containerPort: 22
name: "ssh"
- containerPort: 5900
name: "vnc"
volumeMounts:
- mountPath: /tmp
name: maintenance
volumes:
- name: maintenance
persistentVolumeClaim:
claimName: maintenance
```

- Use `kubectl exec -n external-secrets -it <pod name> -- bash` to attach to the container.

- Download JSONPath.sh

```bash
sudo apt-get update && sudo apt-get install -y gawk
curl -O https://raw.githubusercontent.com/mclarkson/JSONPath.sh/master/JSONPath.sh

Check warning on line 196 in README.md

View check run for this annotation

In Solidarity / Inclusive Language

Match Found

Please consider an alternative to `master`. Possibilities include: `primary`, `main`, `leader`, `active`, `writer`
Raw output
/master/gi
chmod +x JSONPath.sh
```

- Query the endpoint

```bash
curl bitwarden-eso-provider.external-secrets.svc.cluster.local:8087/list/object/items
```

- Test a JSONPath filter

```bash
curl bitwarden-eso-provider.external-secrets.svc.cluster.local:8087/list/object/items?search=zitadel \
| JSONPath.sh '$.data'

```

## Status
Actively maintained mostly by @jessebot and @cloudymax, but we'd love to have your help if you'd like to make improvements (bugs or feature fixes). We mostly test on k3s. Feel free to submit a GitHub issue to _this_ repo (_not_ the Bitwarden repos) if you need help. You're also welcome to submit PRs to this repo, and we'd love to review them 💙
Actively maintained mostly by @jessebot and @cloudymax, but we'd love to have your help if you'd like to make improvements (bugs or feature fixes). We mostly test on k3s. Feel free to submit a GitHub issue to _this_ repo (_not_ the Bitwarden repos) if you need help. You're also welcome to submit PRs to this repo, and we'd love to review them 💙 Star the repo if you find it helpful <3

## Acknowledgements
We followed the [example](https://external-secrets.io/v0.9.2/examples/bitwarden/) over at the ESO docs to create this helm chart :)
4 changes: 2 additions & 2 deletions charts/bitwarden-eso-provider/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ type: application
# This is the chart version. This version number should be incremented each time you make changes
# to the chart and its templates, including the app version.
# Versions are expected to follow Semantic Versioning (https://semver.org/)
version: 0.4.1
version: 0.5.0

# renovate: image=jessebot/bweso
appVersion: "v0.2.0"
appVersion: "v0.3.0"

maintainers:
- name: "cloudymax"
Expand Down
119 changes: 2 additions & 117 deletions charts/bitwarden-eso-provider/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# bitwarden-eso-provider

![Version: 0.4.1](https://img.shields.io/badge/Version-0.4.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.2.0](https://img.shields.io/badge/AppVersion-v0.2.0-informational?style=flat-square)
![Version: 0.5.0](https://img.shields.io/badge/Version-0.5.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: v0.3.0](https://img.shields.io/badge/AppVersion-v0.3.0-informational?style=flat-square)

Helm chart to use Bitwarden as a Provider for External Secrets Operator

Expand Down Expand Up @@ -63,119 +63,4 @@ Helm chart to use Bitwarden as a Provider for External Secrets Operator
| tolerations | list | `[]` | |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)


## Testing

Comment on lines -69 to -70
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cloudymax this whole section gets removed by helm-docs automatically, so I moved it to the root level readme so that doesn't happen in the future.

Searching for items has to be done using JSONpath, you will need to install a utility for that, we use [bashtools/JSONPath.sh](https://github.com/bashtools/JSONPath.sh).

To query the endpoint you will need to deploy a maintenance container into the `external-secrets` namespace.

```yaml
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: maintenance
namespace: external-secrets
annotations:
# set to "true" to include in future backups
k8up.io/backup: "false"
# Optional:
#labels:
# app: multi-file-writer
spec:
# Optional:
storageClassName: local-path
accessModes:
- ReadWriteOnce
resources:
requests:
# Must be sufficient to hold your data
storage: 16Gi
---
kind: PersistentVolumeClaim
apiVersion: v1
metadata:
name: maintenance
namespace: external-secrets
annotations:
# set to "true" to include in future backups
k8up.io/backup: "false"
# Optional:
#labels:
# app: multi-file-writer
spec:
# Optional:
storageClassName: local-path
accessModes:
- ReadWriteOnce
resources:
requests:
# Must be sufficient to hold your data
storage: 16Gi
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: maintenance
namespace: external-secrets
spec:
selector:
matchLabels:
app: onboardme
template:
metadata:
labels:
app: onboardme
spec:
restartPolicy: Always
containers:
- name: onboardme
image: jessebot/onboardme:debian12
command:
- /bin/sleep
- 3650d
imagePullPolicy: IfNotPresent
ports:
- containerPort: 80
name: "http"
- containerPort: 443
name: "https"
- containerPort: 22
name: "ssh"
- containerPort: 5900
name: "vnc"
volumeMounts:
- mountPath: /tmp
name: maintenance
volumes:
- name: maintenance
persistentVolumeClaim:
claimName: maintenance
```

- Use `kubectl exec -n external-secrets -it <pod name> -- bash` to attach to the conatiner.

- Download JSONPath.sh

```bash
sudo apt-get update && sudo apt-get install -y gawk
curl -O https://raw.githubusercontent.com/mclarkson/JSONPath.sh/master/JSONPath.sh
chmod +x JSONPath.sh
```

- Query the endpoint

```bash
curl bitwarden-eso-provider.external-secrets.svc.cluster.local:8087/list/object/items
```

- Test a JSONPath filter

```bash
curl bitwarden-eso-provider.external-secrets.svc.cluster.local:8087/list/object/items?search=zitadel \
| JSONPath.sh '$.data'

```
Autogenerated from chart metadata using [helm-docs v1.11.3](https://github.com/norwoodj/helm-docs/releases/v1.11.3)
Loading