Michal.Wrobel/openbao-helm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Issue 6: Changed some of the Hashicorp Vault refences in the docs to OpenBao.

Browse source 
Signed-off-by: Nathan Phelps <naphelps@us.ibm.com>
This commit is contained in:
Nathan Phelps 2024-05-17 10:00:44 -04:00 committed by Nathan A Phelps
parent 7ad371f159
commit be6fa5a195
7 changed files with 26 additions and 30 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/ISSUE_TEMPLATE/bug_report.md vendored
View file

@ -11,7 +11,7 @@ assignees: ''
For questions, the best place to get answers is on our [discussion forum](https://discuss.hashicorp.com/c/vault), as they will get more visibility from experienced users than the issue tracker.
Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in Vault Helm, _please responsibly disclose_ by contacting us at [security@hashicorp.com](mailto:security@hashicorp.com).
Please note: We take Vault's security and our users' trust very seriously. If you believe you have found a security issue in OpenBao Helm, _please responsibly disclose_ by contacting us at [openbao-security@lists.lfedge.org](mailto:openbao-security@lists.lfedge.org).
-->

1
CODEOWNERS
View file

@ -1 +0,0 @@
* @hashicorp/vault-ecosystem

29
CONTRIBUTING.md
View file

@ -1,8 +1,8 @@
# Contributing to Vault Helm
# Contributing to OpenBao Helm
**Please note:** We take Vault's security and our users' trust very seriously.
If you believe you have found a security issue in Vault, please responsibly
disclose by contacting us at security@hashicorp.com.
**Please note:** We take OpenBao's security and our users' trust very seriously.
If you believe you have found a security issue in OpenBao, please responsibly
disclose by contacting us at openbao-security@lists.lfedge.org.
**First:** if you're unsure or afraid of _anything_, just ask or submit the
issue or pull request anyways. You won't be yelled at for giving it your best
@ -12,14 +12,15 @@ rules to get in the way of that.
That said, if you want to ensure that a pull request is likely to be merged,
talk to us! You can find out our thoughts and ensure that your contribution
won't clash or be obviated by Vault's normal direction. A great way to do this
is via the [Vault Discussion Forum][1].
won't clash or be obviated by OpenBao's normal direction. A great way to do this
is via the [Linux Foundation Element chat server][1], or [mailing list][2].
This document will cover what we're looking for in terms of reporting issues.
By addressing all the points we're looking for, it raises the chances we can
quickly merge or address your contributions.
[1]: https://discuss.hashicorp.com/c/vault
[1]: https://chat.lfx.linuxfoundation.org
[2]: https://lists.lfedge.org/g/openbao
## Issues
@ -33,14 +34,14 @@ quickly merge or address your contributions.
* Provide steps to reproduce the issue, and if possible include the expected
results as well as the actual results. Please provide text, not screen shots!
* Respond as promptly as possible to any questions made by the Vault
* Respond as promptly as possible to any questions made by the OpenBao
team to your issue. Stale issues will be closed periodically.
### Issue Lifecycle
1. The issue is reported.
2. The issue is verified and categorized by a Vault Helm collaborator.
2. The issue is verified and categorized by a OpenBao Helm collaborator.
Categorization is done via tags. For example, bugs are marked as "bugs".
3. Unless it is critical, the issue may be left for a period of time (sometimes
@ -70,25 +71,25 @@ The following are the instructions for running bats tests using a Docker contain
#### Prerequisites
* Docker installed
* `vault-helm` checked out locally
* `openbao-helm` checked out locally
#### Test
**Note:** the following commands should be run from the `vault-helm` directory.
**Note:** the following commands should be run from the `openbao-helm` directory.
First, build the Docker image for running the tests:
```shell
docker build -f ${PWD}/test/docker/Test.dockerfile ${PWD}/test/docker/ -t vault-helm-test
docker build -f ${PWD}/test/docker/Test.dockerfile ${PWD}/test/docker/ -t openbao-helm-test
```
Next, execute the tests with the following commands:
```shell
docker run -it --rm -v "${PWD}:/test" vault-helm-test bats /test/test/unit
docker run -it --rm -v "${PWD}:/test" openbao-helm-test bats /test/test/unit
```
It's possible to only run specific bats tests using regular expressions.
For example, the following will run only tests with "injector" in the name:
```shell
docker run -it --rm -v "${PWD}:/test" vault-helm-test bats /test/test/unit -f "injector"
docker run -it --rm -v "${PWD}:/test" openbao-helm-test bats /test/test/unit -f "injector"
```
### Test Manually

2
README.md
View file

@ -23,7 +23,7 @@ The versions required are:
## Usage
To install the latest version of this chart, add the Hashicorp helm repository and run `helm install`:
To install the latest version of this chart, add the OpenBao helm repository and run `helm install`:
```console
helm repo add openbao https://openbao.github.io/openbao-helm

6
charts/openbao/README.md
View file

@ -9,8 +9,8 @@ Official OpenBao Chart
## Maintainers
| Name | Email | Url |
| ---- | ------ | --- |
| OpenBao | | <https://openbao.org> |
|---------|------------------------------------|-----------------------|
| OpenBao | https://lists.lfedge.org/g/openbao | <https://openbao.org> |
## Source Code
@ -171,8 +171,6 @@ Kubernetes: `>= 1.27.0-0`
| server.dev.devRootToken | string | `"root"` | |
| server.dev.enabled | bool | `false` | |
| server.enabled | string | `"-"` | |
| server.enterpriseLicense.secretKey | string | `"license"` | |
| server.enterpriseLicense.secretName | string | `""` | |
| server.extraArgs | string | `""` | |
| server.extraContainers | string | `nil` | |
| server.extraEnvironmentVars | object | `{}` | |

6
charts/openbao/templates/NOTES.txt
View file

@ -1,10 +1,10 @@
Thank you for installing HashiCorp Vault!
Thank you for installing OpenBao!
Now that you have deployed Vault, you should look over the docs on using
Now that you have deployed OpenBao, you should look over the docs on using
Vault with Kubernetes available here:
https://developer.hashicorp.com/vault/docs
https://openbao.org/docs/
Your release is named {{ .Release.Name }}. To learn more about the release, try:

8
test/README.md
View file

@ -1,11 +1,9 @@
# Vault Helm Tests
# OpenBao Helm Tests
## Running Vault Helm Acceptance tests
## Running OpenBao Helm Acceptance tests
The Makefile at the top level of this repo contains a few target that should help with running acceptance tests in your own GKE instance or in a kind cluster.
Note that for the Vault Enterprise tests to pass, a `VAULT_LICENSE_CI` environment variable needs to be set to the contents of a valid Vault Enterprise license.
### Running in a GKE cluster
* Set the `GOOGLE_CREDENTIALS` and `CLOUDSDK_CORE_PROJECT` variables at the top of the file. `GOOGLE_CREDENTIALS` should contain the local path to your Google Cloud Platform account credentials in JSON format. `CLOUDSDK_CORE_PROJECT` should be set to the ID of your GCP project.
@ -49,7 +47,7 @@ editing will be required, since several properties accept multiple data types.
## Helm test
Vault Helm also contains a simple helm test under
OpenBao Helm also contains a simple helm test under
[templates/tests/](../templates/tests/) that may be run against a helm release:
helm test <RELEASE_NAME>