Skip to content

Commit

Permalink
Prepare 2.0.0-rc0 release
Browse files Browse the repository at this point in the history
Signed-off-by: Emiliano Suñé <[email protected]>
  • Loading branch information
esune committed Sep 28, 2023
1 parent a88d33b commit 4711acd
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 21 deletions.
19 changes: 2 additions & 17 deletions charts/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,3 @@
# Deploying vc-authn-oidc
# VC-AuthN OIDC

Until an Aries Cloudagent Python helm chart is available to be used as dependency, the templates in the [openshift](../openshift/) folder should be used to deploy the agent component. This should be done *before* executing the charts that deploy `vc-authn` and remaining dependencies.

*Note:* the provided configurations are for OpenShift.

## Configuration
Use the `acapy` section in the chart to specify the settings for the target agent:

- `agentUrl`: this is the public URL for the agent (also known as endpoint)
- `adminUrl`: this is the URL to the admin interface of the agent - it will be used by `vc-authn-oidc` to control it
- `existingSecret`: the name of an existing secret containing the values for `x-api-key` (otherwise set using `adminApiKey`), `wallet-id` and `wallet-key` (otherwise set using `tenant.walletId` and `tenant.walletKey`).
- `useOob`: values are `true` or `false` (default `false`). If set to `true`, use OOB rather than connection-less to generate a proof-request.
- `adminApiKey`: the value of the `x-api-key` header to be used when making requests to the aca-py instance
existingSecret: ""
- `tenancyMode`: valid options are `multi` and `single`. If `multi` is selected, the following `tenant` section must be completed as well.
- `tenant.walletId`: the wallet id to be used to authenticate with the Traction tenant.
- `tenant.walletKey`: the wallet key to be used to authenticate with the Traction tenant.
Helm charts to deploy VC-AuthN OIDC in k8s
4 changes: 2 additions & 2 deletions charts/vc-authn-oidc/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ 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.1.3
version: 0.1.4

# This is the version number of the application being deployed. This version number should be
# incremented each time you make changes to the application. Versions are not expected to
# follow Semantic Versioning. They should reflect the version the application is using.
# It is recommended to use it with quotes.
appVersion: "2.0.0-beta3"
appVersion: "2.0.0-rc0"

# Charts the vc-authn-oidc service depends on
dependencies:
Expand Down
5 changes: 3 additions & 2 deletions charts/vc-authn-oidc/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# VC-AuthN OIDC

![Version: 0.1.0](https://img.shields.io/badge/Version-0.1.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0-alpha1](https://img.shields.io/badge/AppVersion-2.0.0--alpha1-informational?style=flat-square)
![Version: 0.1.4](https://img.shields.io/badge/Version-0.1.4-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 2.0.0-rc0](https://img.shields.io/badge/AppVersion-2.0.0--rc0-informational?style=flat-square)

A Helm chart to deploy Verifiable Credential Identity Provider for OpenID Connect.

Expand All @@ -11,7 +11,8 @@ Make sure to read the [best practices](/docs/BestPractices.md) to be used when p
## TL;DR

```console
helm install my-release charts/vc-authn-oidc
helm repo add vc-authn-oidc https://bcgov.github.io/vc-authn-oidc
helm install my-release vc-authn-oidc/vc-authn-oidc
```

## Prerequisites
Expand Down

0 comments on commit 4711acd

Please sign in to comment.