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

Issue 6: Changed some of the Hashicorp Vault references in the docs to OpenBao #7

Merged
merged 5 commits into from
May 20, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

-->

Expand Down
1 change: 0 additions & 1 deletion CODEOWNERS

This file was deleted.

29 changes: 15 additions & 14 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion charts/openbao/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

apiVersion: v2
name: openbao
version: 0.2.0
version: 0.3.0
appVersion: v2.0.0-alpha20240329
kubeVersion: ">= 1.27.0-0"
description: Official OpenBao Chart
Expand Down
10 changes: 4 additions & 6 deletions charts/openbao/README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# openbao

![Version: 0.2.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![AppVersion: v2.0.0-alpha20240329](https://img.shields.io/badge/AppVersion-v2.0.0--alpha20240329-informational?style=flat-square)
![Version: 0.3.0](https://img.shields.io/badge/Version-0.2.0-informational?style=flat-square) ![AppVersion: v2.0.0-alpha20240329](https://img.shields.io/badge/AppVersion-v2.0.0--alpha20240329-informational?style=flat-square)

Official OpenBao Chart

**Homepage:** <https://github.com/openbao/openbao-helm>

## Maintainers

| Name | Email | Url |
| ---- | ------ | --- |
| OpenBao | | <https://openbao.org> |
| Name | Email | Url |
|---------|------------------------------------|-----------------------|
| OpenBao | https://lists.lfedge.org/g/openbao | <https://openbao.org> |

## Source Code

Expand Down Expand Up @@ -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"` | |
naphelps marked this conversation as resolved.
Show resolved Hide resolved
| server.enterpriseLicense.secretName | string | `""` | |
| server.extraArgs | string | `""` | |
| server.extraContainers | string | `nil` | |
| server.extraEnvironmentVars | object | `{}` | |
Expand Down
6 changes: 3 additions & 3 deletions charts/openbao/templates/NOTES.txt
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
11 changes: 0 additions & 11 deletions charts/openbao/templates/_helpers.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -201,12 +201,6 @@ extra volumes the user may have specified (such as a secret with TLS).
{{- if .Values.server.volumes }}
{{- toYaml .Values.server.volumes | nindent 8}}
{{- end }}
{{- if (and .Values.server.enterpriseLicense.secretName .Values.server.enterpriseLicense.secretKey) }}
- name: vault-license
secret:
secretName: {{ .Values.server.enterpriseLicense.secretName }}
defaultMode: 0440
{{- end }}
{{- end -}}

{{/*
Expand Down Expand Up @@ -270,11 +264,6 @@ based on the mode configured.
{{- if .Values.server.volumeMounts }}
{{- toYaml .Values.server.volumeMounts | nindent 12}}
{{- end }}
{{- if (and .Values.server.enterpriseLicense.secretName .Values.server.enterpriseLicense.secretKey) }}
- name: vault-license
mountPath: /vault/license
readOnly: true
{{- end }}
{{- end -}}

{{/*
Expand Down
4 changes: 0 additions & 4 deletions charts/openbao/templates/server-statefulset.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -137,10 +137,6 @@ spec:
- name: VAULT_LOG_FORMAT
value: "{{ .Values.server.logFormat }}"
{{- end }}
{{- if (and .Values.server.enterpriseLicense.secretName .Values.server.enterpriseLicense.secretKey) }}
- name: VAULT_LICENSE_PATH
value: /vault/license/{{ .Values.server.enterpriseLicense.secretKey }}
{{- end }}
{{ template "vault.envs" . }}
{{- include "vault.extraEnvironmentVars" .Values.server | nindent 12 }}
{{- include "vault.extraSecretEnvironmentVars" .Values.server | nindent 12 }}
Expand Down
12 changes: 0 additions & 12 deletions charts/openbao/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -369,18 +369,6 @@ server:
# See vault.mode in _helpers.tpl for implementation details.
enabled: "-"

# [Enterprise Only] This value refers to a Kubernetes secret that you have
# created that contains your enterprise license. If you are not using an
# enterprise image or if you plan to introduce the license key via another
# route, then leave secretName blank ("") or set it to null.
# Requires Vault Enterprise 1.8 or later.
enterpriseLicense:
# The name of the Kubernetes secret that holds the enterprise license. The
# secret must be in the same namespace that Vault is installed into.
secretName: ""
# The key within the Kubernetes secret that holds the enterprise license.
secretKey: "license"

# Resource requests, limits, etc. for the server cluster placement. This
# should map directly to the value of the resources field for a PodSpec.
# By default no direct resource request is made.
Expand Down
8 changes: 3 additions & 5 deletions test/README.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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>
Loading