Skip to content

Commit

Permalink
docs: updating readme's
Browse files Browse the repository at this point in the history
  • Loading branch information
@nexus49
nexus49 committed Jan 7, 2025
1 parent 6ae8cd2 commit 2f24157
Show file tree
Hide file tree
Showing 22 changed files with 205 additions and 205 deletions.
2 changes: 1 addition & 1 deletion charts/account-operator-crds/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ description: A Helm chart for Kubernetes

type: application

version: 0.1.9
version: 0.1.10

appVersion: "0.0.0"
6 changes: 3 additions & 3 deletions charts/account-operator-crds/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ A Helm chart for Kubernetes

![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square)
## Values
| Key | Type | Default | Description |
| ----------- | ---- | ------- | ----------- |
| kcp.enabled | bool | `false` | Enable KCP |
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| kcp.enabled | bool | `false` | Enable KCP |

## Overriding Values

Expand Down
2 changes: 1 addition & 1 deletion charts/account-operator/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: account-operator
description: A Helm chart to deploy OpenMFP Account-Operator
type: application
version: 0.5.34
version: 0.5.35
appVersion: "0.129.0"
dependencies:
- name: account-operator-crds
Expand Down
56 changes: 28 additions & 28 deletions charts/account-operator/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,35 +6,35 @@ A Helm chart to deploy OpenMFP Account-Operator

## Requirements

| Repository | Name | Description | Sources |
| ----------------------------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) |
| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds) |
| Repository | Name | Description | Sources |
|------------|------|-------------|---------|
| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|
| `oci://ghcr.io/openmfp/helm-charts` | `account-operator-crds` | The `account-operator-crds` chart provides CRDS introduced by the `account-operator`. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/account-operator-crds)|
## Values
| Key | Type | Default | Description |
| ----------------------------------- | ------ | -------------------------------------------- | -------------------------------------- |
| crds.enabled | bool | `true` | Enable CRDs |
| deployment.specTemplate.annotations | object | `{}` | The annotations for the deployment |
| deployment.specTemplate.labels | object | `{}` | The labels for the deployment |
| image.name | string | `"ghcr.io/openmfp/account-operator"` | The image repository |
| image.tag | string | `"latest"` | The image tag |
| kcp | object | `{"enabled":false,"virtualWorkspaceUrl":""}` | The KCP configuration |
| kcp.enabled | bool | `false` | Enable KCP |
| kcp.virtualWorkspaceUrl | string | `""` | The URL for the virtual workspace |
| kubeconfigSecret | string | `""` | The secret for kubeconfig |
| logLevel | string | `"warn"` | The log level |
| security.mountServiceAccountToken | bool | `false` | Mount the service account token |
| subroutines.extension.enabled | bool | `true` | Enable extension subroutines |
| subroutines.extensionReady.enabled | bool | `true` | Enable extension ready subroutines |
| subroutines.fga.creatorRelation | string | `"owner"` | The creator relation for FGA |
| subroutines.fga.enabled | bool | `true` | Enable FGA subroutines |
| subroutines.fga.grpcAddr | string | `""` | The gRPC address for FGA |
| subroutines.fga.objectType | string | `"account"` | The object type for FGA |
| subroutines.fga.parentRelation | string | `"parent"` | The parent relation for FGA |
| subroutines.fga.rootNamespace | string | `"openmfp-root"` | The root namespace for FGA |
| subroutines.namespace.enabled | bool | `true` | Enable namespace subroutines |
| webhooks.certDir | string | `"/certs"` | The directory for webhook certificates |
| webhooks.enabled | bool | `false` | Enable webhooks |
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| crds.enabled | bool | `true` | Enable CRDs |
| deployment.specTemplate.annotations | object | `{}` | The annotations for the deployment |
| deployment.specTemplate.labels | object | `{}` | The labels for the deployment |
| image.name | string | `"ghcr.io/openmfp/account-operator"` | The image repository |
| image.tag | string | `"latest"` | The image tag |
| kcp | object | `{"enabled":false,"virtualWorkspaceUrl":""}` | The KCP configuration |
| kcp.enabled | bool | `false` | Enable KCP |
| kcp.virtualWorkspaceUrl | string | `""` | The URL for the virtual workspace |
| kubeconfigSecret | string | `""` | The secret for kubeconfig |
| logLevel | string | `"warn"` | The log level |
| security.mountServiceAccountToken | bool | `false` | Mount the service account token |
| subroutines.extension.enabled | bool | `true` | Enable extension subroutines |
| subroutines.extensionReady.enabled | bool | `true` | Enable extension ready subroutines |
| subroutines.fga.creatorRelation | string | `"owner"` | The creator relation for FGA |
| subroutines.fga.enabled | bool | `true` | Enable FGA subroutines |
| subroutines.fga.grpcAddr | string | `""` | The gRPC address for FGA |
| subroutines.fga.objectType | string | `"account"` | The object type for FGA |
| subroutines.fga.parentRelation | string | `"parent"` | The parent relation for FGA |
| subroutines.fga.rootNamespace | string | `"openmfp-root"` | The root namespace for FGA |
| subroutines.namespace.enabled | bool | `true` | Enable namespace subroutines |
| webhooks.certDir | string | `"/certs"` | The directory for webhook certificates |
| webhooks.enabled | bool | `false` | Enable webhooks |

## Overriding Values

Expand Down
2 changes: 1 addition & 1 deletion charts/common/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ description: A Helm chart containing reuse templates

type: library

version: 0.2.6
version: 0.2.7
50 changes: 25 additions & 25 deletions charts/common/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,31 +4,31 @@ A Helm chart containing reuse templates

![Type: library](https://img.shields.io/badge/Type-library-informational?style=flat-square)
## Values
| Key | Type | Default | Description |
| ---------------------------------------- | ------ | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager |
| defaults.deployment.maxSurge | int | `5` | maxSurge |
| defaults.deployment.maxUnavailable | int | `0` | maxUnavailable |
| defaults.deployment.resources.limits | object | `{"cpu":"100m","memory":"512Mi"}` | cpu and memory limits for the deployment |
| defaults.deployment.resources.requests | object | `{"cpu":"40m","memory":"50Mi"}` | cpu and memory requests for the deployment |
| defaults.deployment.revisionHistoryLimit | int | `3` | deployment revision history limit |
| defaults.deployment.strategy | string | `"RollingUpdate"` | deployment strategy |
| defaults.externalSecrets.enabled | bool | `true` | toggle to enable/disable external-secrets |
| defaults.fga.enabled | bool | `false` | toggle to enable/disable experimental FGA features |
| defaults.health.liveness | object | `{"failureThreshold":1,"path":"/healthz"}` | liveness probe parameters |
| defaults.health.periodSeconds | int | `10` | health period |
| defaults.health.port | int | `8081` | health port |
| defaults.health.readiness | object | `{"initialDelaySeconds":5,"path":"/readyz","periodSeconds":10}` | readiness probe parameters |
| defaults.health.startup | object | `{"failureThreshold":30,"path":"/readyz"}` | startup probe parameters |
| defaults.imagePullPolicy | string | `"Always"` | imagePullPolicy is the policy to use when pulling images for all charts |
| defaults.imagePullSecret | string | `"github"` | imagePullSecret is the name of the secret that holds the docker registry credentials |
| defaults.istio.enabled | bool | `false` | toggle to enable/disable istio |
| defaults.istio.gateway.name | string | `"gateway"` | name of the gateway |
| defaults.metrics.port | int | `8080` | metrics port |
| defaults.port | int | `8080` | service port |
| defaults.securityContext.fsGroup | int | `2000` | fsGroup id to run the container |
| defaults.securityContext.runAsGroup | int | `3000` | group id to run the container |
| defaults.securityContext.runAsUser | int | `1000` | user id to run the container |
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| defaults.certManager.enabled | bool | `false` | toggle to enable/disable cert-manager |
| defaults.deployment.maxSurge | int | `5` | maxSurge |
| defaults.deployment.maxUnavailable | int | `0` | maxUnavailable |
| defaults.deployment.resources.limits | object | `{"cpu":"100m","memory":"512Mi"}` | cpu and memory limits for the deployment |
| defaults.deployment.resources.requests | object | `{"cpu":"40m","memory":"50Mi"}` | cpu and memory requests for the deployment |
| defaults.deployment.revisionHistoryLimit | int | `3` | deployment revision history limit |
| defaults.deployment.strategy | string | `"RollingUpdate"` | deployment strategy |
| defaults.externalSecrets.enabled | bool | `true` | toggle to enable/disable external-secrets |
| defaults.fga.enabled | bool | `false` | toggle to enable/disable experimental FGA features |
| defaults.health.liveness | object | `{"failureThreshold":1,"path":"/healthz"}` | liveness probe parameters |
| defaults.health.periodSeconds | int | `10` | health period |
| defaults.health.port | int | `8081` | health port |
| defaults.health.readiness | object | `{"initialDelaySeconds":5,"path":"/readyz","periodSeconds":10}` | readiness probe parameters |
| defaults.health.startup | object | `{"failureThreshold":30,"path":"/readyz"}` | startup probe parameters |
| defaults.imagePullPolicy | string | `"Always"` | imagePullPolicy is the policy to use when pulling images for all charts |
| defaults.imagePullSecret | string | `"github"` | imagePullSecret is the name of the secret that holds the docker registry credentials |
| defaults.istio.enabled | bool | `false` | toggle to enable/disable istio |
| defaults.istio.gateway.name | string | `"gateway"` | name of the gateway |
| defaults.metrics.port | int | `8080` | metrics port |
| defaults.port | int | `8080` | service port |
| defaults.securityContext.fsGroup | int | `2000` | fsGroup id to run the container |
| defaults.securityContext.runAsGroup | int | `3000` | group id to run the container |
| defaults.securityContext.runAsUser | int | `1000` | user id to run the container |

## Overriding Values

Expand Down
2 changes: 1 addition & 1 deletion charts/example-content/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
appVersion: "0.134.0"
description: Helm Chart for the openmfp Portal
name: example-content
version: 0.111.9
version: 0.111.10
dependencies:
- name: common
version: 0.2.6
Expand Down
20 changes: 10 additions & 10 deletions charts/example-content/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Helm Chart for the openmfp Portal

## Requirements

| Repository | Name | Description | Sources |
| ----------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. | [source](https://github.com/openmfp/helm-charts/tree/main/charts/common) |
| Repository | Name | Description | Sources |
|------------|------|-------------|---------|
| `oci://ghcr.io/openmfp/helm-charts` | `common` | The `common` chart is a library of common resources that are shared across all other charts in the repository. It has no templates, but provides helm template functions and [default values](https://github.com/openmfp/helm-charts/blob/main/charts/common/values.yaml) that can be used by other charts. |[source](https://github.com/openmfp/helm-charts/tree/main/charts/common)|
## Values
| Key | Type | Default | Description |
| ---------------------------------------------------- | ------ | ----------------------------------- | ----------------------------------------------------------------- |
| contentConfigurations.home | bool | `true` | This content configuration enables a basic homepage in the portal |
| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name |
| istio.virtualService.hosts[0] | string | `"your-host.com"` | |
| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` | |
| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` | |
| Key | Type | Default | Description |
|-----|------|---------|-------------|
| contentConfigurations.home | bool | `true` | This content configuration enables a basic homepage in the portal |
| image.name | string | `"ghcr.io/openmfp/example-content"` | The image name |
| istio.virtualService.hosts[0] | string | `"your-host.com"` | |
| istio.virtualService.matchers[0].match[0].uri.exact | string | `"/ui/example-content"` | |
| istio.virtualService.matchers[0].match[1].uri.prefix | string | `"/ui/example-content/"` | |

## Overriding Values

Expand Down
2 changes: 1 addition & 1 deletion charts/extension-manager-operator-crds/Chart.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@ name: extension-manager-operator-crds
description: A Helm chart for Kubernetes

type: application
version: 0.1.6
version: 0.1.7
appVersion: "0.0.0"
Loading

0 comments on commit 2f24157

Please sign in to comment.