From 2e59007d78bc69819797168f807fe268c0c35dae Mon Sep 17 00:00:00 2001 From: Sean Trantalis Date: Sun, 28 Apr 2024 08:37:07 -0400 Subject: [PATCH] docs: update usage docs --- DEVELOPMENT.md | 14 +++++++++++++ LICENSE | 19 +++++++++++++++++ README.md | 36 +++++++++++++++++++++----------- charts/platform/README.md | 6 +++--- charts/platform/README.md.gotmpl | 2 +- 5 files changed, 61 insertions(+), 16 deletions(-) create mode 100644 DEVELOPMENT.md create mode 100644 LICENSE diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md new file mode 100644 index 0000000..ed106ea --- /dev/null +++ b/DEVELOPMENT.md @@ -0,0 +1,14 @@ +## Development + +### Prerequisites + +- [Helm](https://helm.sh/docs/intro/install/) +- [Helm Docs](https://github.com/norwoodj/helm-docs) +- [Pre-commit](https://pre-commit.com/index.html#installation) + +### Install pre-commit hooks + + ```sh + pre-commit install + pre-commit install-hooks + ``` diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..156808c --- /dev/null +++ b/LICENSE @@ -0,0 +1,19 @@ +# The Clear BSD License + +Copyright 2023 Virtru Corporation +All rights reserved. + +Redistribution and use in source and binary forms, with or without modification, are permitted (subject to the limitations in the disclaimer below) +provided that the following conditions are met: + +* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. +* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation + and/or other materials provided with the distribution. +* Neither the name of Virtru Corporation nor the names of its contributors may be used to endorse or promote products derived from this software without + specific prior written permission. +NO EXPRESS OR IMPLIED LICENSES TO ANY PARTY'S PATENT RIGHTS ARE GRANTED BY THIS LICENSE. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND +CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A +PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, +EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) +ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE diff --git a/README.md b/README.md index eb8009f..0d17091 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,32 @@ +

+ +

+ +

+ + + + + +

+ # OpenTDF Helm Charts -## Charts +## Usage -- [Platform](charts/platform/README.md) +[Helm](https://helm.sh) must be installed to use the charts. Please refer to +Helm's [documentation](https://helm.sh/docs) to get started -## Development +Once Helm has been set up correctly, add the repo as follows: -### Prerequisites + helm repo add opentdf https://opentdf.github.io/charts -- [Helm](https://helm.sh/docs/intro/install/) -- [Helm Docs](https://github.com/norwoodj/helm-docs) -- [Pre-commit](https://pre-commit.com/index.html#installation) +If you had already added this repo earlier, run `helm repo update` to retrieve +the latest versions of the packages. You can then run `helm search repo +opentdf` to see the charts. -### Install pre-commit hooks +For chart specific documentation, please refer to the README.md files in the respective chart directories. - ```sh - pre-commit install - pre-commit install-hooks - ``` +### Charts + +- [Platform](charts/platform/README.md) diff --git a/charts/platform/README.md b/charts/platform/README.md index e6951c7..9319e4a 100644 --- a/charts/platform/README.md +++ b/charts/platform/README.md @@ -1,6 +1,6 @@ # platform -![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: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square) +![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 0.1.0](https://img.shields.io/badge/AppVersion-0.1.0-informational?style=flat-square) A Helm Chart for OpenTDF Platform @@ -9,10 +9,10 @@ A Helm Chart for OpenTDF Platform In order to run the platform you need a supported identity provider and postgres database. We have included the following charts as dependencies: - [Keycloak](https://www.keycloak.org/guides) - - + - [Helm Chart](https://artifacthub.io/packages/helm/bitnami/keycloak) - [Postgres](https://www.postgresql.org/) - - + - [Helm Chart](https://artifacthub.io/packages/helm/bitnami/postgresql) If you want to deploy keycloak and postgresql as part of the platform deployment make sure to follow [Playground Configuration](#playground-configuration-optional) section. diff --git a/charts/platform/README.md.gotmpl b/charts/platform/README.md.gotmpl index dee7981..93afe9f 100644 --- a/charts/platform/README.md.gotmpl +++ b/charts/platform/README.md.gotmpl @@ -119,4 +119,4 @@ grpcurl -insecure $PLATFORM_HOST:443 kas.AccessService/PublicKey {{ template "chart.requirementsSection" . }} -{{ template "chart.valuesSection" . }} +{{ template "chart.valuesSection" . }} \ No newline at end of file