Skip to content

Commit

Permalink
Documentation cleanup (#97)
Browse files Browse the repository at this point in the history
Fix links to the repo after move. Remove references to other versions
of images we don't support.

Signed-off-by: Kevin Fox <Kevin.Fox@pnnl.gov>
  • Loading branch information
kfox1111 authored Nov 11, 2023
1 parent 250666a commit f5d1376
Show file tree
Hide file tree
Showing 10 changed files with 18 additions and 42 deletions.
4 changes: 2 additions & 2 deletions charts/spire/charts/spiffe-csi-driver/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ type: application
version: 0.1.0
appVersion: "0.2.3"
keywords: ["spiffe", "csi-driver"]
home: https://github.com/spiffe/helm-charts/tree/main/charts/spire
home: https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
sources:
- https://github.com/spiffe/helm-charts/tree/main/charts/spire
- https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
icon: https://spiffe.io/img/logos/spire/icon/color/spire-icon-color.png
maintainers:
- name: marcofranssen
Expand Down
8 changes: 2 additions & 6 deletions charts/spire/charts/spiffe-csi-driver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,7 @@

A Helm chart to install the SPIFFE CSI driver.

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

> [!Note]
> The recommended version is `0.2.3` to support arm64 nodes. If running with any
> prior version to `0.2.3` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
**Homepage:** <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Maintainers

Expand All @@ -21,7 +17,7 @@ A Helm chart to install the SPIFFE CSI driver.

## Source Code

* <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
* <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

<!-- The parameters section is generated using helm-docs.sh and should not be edited by hand. -->

Expand Down
4 changes: 2 additions & 2 deletions charts/spire/charts/spiffe-oidc-discovery-provider/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ type: application
version: 0.1.0
appVersion: "1.8.4"
keywords: ["spiffe", "oidc"]
home: https://github.com/spiffe/helm-charts/tree/main/charts/spire
home: https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
sources:
- https://github.com/spiffe/helm-charts/tree/main/charts/spire
- https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
icon: https://spiffe.io/img/logos/spire/icon/color/spire-icon-color.png
maintainers:
- name: marcofranssen
Expand Down
9 changes: 2 additions & 7 deletions charts/spire/charts/spiffe-oidc-discovery-provider/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@

A Helm chart to install the SPIFFE OIDC discovery provider.

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

> [!Note]
> Minimum Spire version is `1.5.3`.
> The recommended version is `1.6.0` to support arm64 nodes. If running with any
> prior version to `1.6.0` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
**Homepage:** <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Maintainers

Expand All @@ -22,7 +17,7 @@ A Helm chart to install the SPIFFE OIDC discovery provider.

## Source Code

* <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
* <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

<!-- The parameters section is generated using helm-docs.sh and should not be edited by hand. -->

Expand Down
4 changes: 2 additions & 2 deletions charts/spire/charts/spire-agent/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ type: application
version: 0.1.0
appVersion: "1.8.4"
keywords: ["spiffe", "spire-agent"]
home: https://github.com/spiffe/helm-charts/tree/main/charts/spire
home: https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
sources:
- https://github.com/spiffe/helm-charts/tree/main/charts/spire
- https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
icon: https://spiffe.io/img/logos/spire/icon/color/spire-icon-color.png
maintainers:
- name: marcofranssen
Expand Down
9 changes: 2 additions & 7 deletions charts/spire/charts/spire-agent/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,7 @@

A Helm chart to install the SPIRE agent.

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

> [!Note]
> Minimum Spire version is `1.5.3`.
> The recommended version is `1.6.0` to support arm64 nodes. If running with any
> prior version to `1.6.0` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
**Homepage:** <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Maintainers

Expand All @@ -22,7 +17,7 @@ A Helm chart to install the SPIRE agent.

## Source Code

* <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
* <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

<!-- The parameters section is generated using helm-docs.sh and should not be edited by hand. -->

Expand Down
4 changes: 2 additions & 2 deletions charts/spire/charts/spire-server/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ type: application
version: 0.1.0
appVersion: "1.8.4"
keywords: ["spiffe", "spire-server", "spire-controller-manager"]
home: https://github.com/spiffe/helm-charts/tree/main/charts/spire
home: https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
sources:
- https://github.com/spiffe/helm-charts/tree/main/charts/spire
- https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
icon: https://spiffe.io/img/logos/spire/icon/color/spire-icon-color.png
maintainers:
- name: marcofranssen
Expand Down
12 changes: 2 additions & 10 deletions charts/spire/charts/spire-server/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,7 @@

A Helm chart to install the SPIRE server.

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>

> [!Note]
> Minimum Spire version is `1.5.3`.
> The recommended version is `1.6.0` to support arm64 nodes. If running with any
> prior version to `1.6.0` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
>
> The recommended spire-controller-manager version is `0.2.2` to support arm64 nodes. If running with any
> prior version to `0.2.2` you have to use a `nodeSelector` to limit to `kubernetes.io/arch: amd64`.
**Homepage:** <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Maintainers

Expand All @@ -25,7 +17,7 @@ A Helm chart to install the SPIRE server.

## Source Code

* <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
* <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Tornjak

Expand Down
2 changes: 1 addition & 1 deletion charts/spire/charts/tornjak-frontend/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: A Helm chart to deploy Tornjak frontend
type: application
version: 0.1.0
appVersion: "v1.4.0"
home: https://github.com/spiffe/helm-charts/tree/main/charts/spire
home: https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire
sources:
- https://github.com/spiffe/tornjak
icon: https://raw.githubusercontent.com/spiffe/tornjak/main/logos/logo%2Btornjak.2132x1291.png
Expand Down
4 changes: 1 addition & 3 deletions charts/spire/charts/tornjak-frontend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

A Helm chart to deploy Tornjak frontend

**Homepage:** <https://github.com/spiffe/helm-charts/tree/main/charts/spire>
**Homepage:** <https://github.com/spiffe/helm-charts-hardened/tree/main/charts/spire>

## Version support

Expand All @@ -16,8 +16,6 @@ A Helm chart to deploy Tornjak frontend
| Dependency | Supported Versions |
|:-----------|:-------------------|
| SPIRE | `1.5.3+`, `1.6.x` |
| Tornjak | `1.0.x` |
| Helm | `3.x` |

## Tornjak
Expand Down

0 comments on commit f5d1376

Please sign in to comment.