You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Thank you for your interest in contributing to the 1Password Kubernetes Operator project 👋! Before you start, please take a moment to read through this guide to understand our contribution process.
4
+
5
+
## Testing
6
+
7
+
- For functional testing, run the local version of the operator. From the project root:
8
+
9
+
```sh
10
+
# Go to the K8s environment (e.g. minikube)
11
+
eval$(minikube docker-env)
12
+
13
+
# Build the local Docker image for the operator
14
+
make docker-build
15
+
16
+
# Deploy the operator
17
+
make deploy
18
+
19
+
# Remove the operator from K8s
20
+
make undeploy
21
+
```
22
+
23
+
- For testing the changes made to the `OnePasswordItem` Custom Resource Definition (CRD), you need to re-generate the object:
24
+
```sh
25
+
make manifests
26
+
```
27
+
28
+
- Run tests for the operator:
29
+
30
+
```sh
31
+
make test
32
+
```
33
+
34
+
You can check other available commands that may come in handy by running `make help`.
35
+
36
+
## Debugging
37
+
38
+
- Running `kubectl describe pod` will fetch details about pods. This includes configuration information about the container(s) and Pod (labels, resource requirements, etc) and status information about the container(s) and Pod (state, readiness, restart count, events, etc.).
39
+
- Running `kubectl logs ${POD_NAME} ${CONTAINER_NAME}` will print the logs from the container(s) in a pod. This can help with debugging issues by inspection.
40
+
- Running `kubectl exec ${POD_NAME} -c ${CONTAINER_NAME} -- ${CMD}` allows executing a command inside a specific container.
41
+
42
+
For more debugging documentation, see: https://kubernetes.io/docs/tasks/debug/debug-application/debug-pods/
43
+
44
+
## Documentation Updates
45
+
46
+
If applicable, update the [USAGEGUIDE.md](./USAGEGUIDE.md) and [README.md](./README.md) to reflect any changes introduced by the new code.
47
+
48
+
## Sign your commits
49
+
50
+
To get your PR merged, we require you to sign your commits. There are three options you can choose from.
51
+
52
+
### Sign commits with 1Password
53
+
54
+
You can sign commits using 1Password, which lets you sign commits with biometrics without the signing key leaving the local 1Password process.
55
+
56
+
Learn how to use [1Password to sign your commits](https://developer.1password.com/docs/ssh/git-commit-signing/).
57
+
58
+
### Sign commits with ssh-agent
59
+
60
+
Follow the steps below to set up commit signing with `ssh-agent`:
61
+
62
+
1.[Generate an SSH key and add it to ssh-agent](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)
63
+
2.[Add the SSH key to your GitHub account](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account)
64
+
3.[Configure git to use your SSH key for commits signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-ssh-key)
65
+
66
+
### Sign commits with gpg
67
+
68
+
Follow the steps below to set up commit signing with `gpg`:
69
+
70
+
1.[Generate a GPG key](https://docs.github.com/en/authentication/managing-commit-signature-verification/generating-a-new-gpg-key)
71
+
2.[Add the GPG key to your GitHub account](https://docs.github.com/en/authentication/managing-commit-signature-verification/adding-a-gpg-key-to-your-github-account)
72
+
3.[Configure git to use your GPG key for commits signing](https://docs.github.com/en/authentication/managing-commit-signature-verification/telling-git-about-your-signing-key#telling-git-about-your-gpg-key)
0 commit comments