Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
LaikaN57 committed Apr 18, 2024
1 parent cc686e9 commit b754c7b
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 13 deletions.
4 changes: 2 additions & 2 deletions charts/rollout-app/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ apiVersion: v2
name: rollout-app
description: Argo Rollout-based Application Helm Chart
type: application
version: 0.8.0
version: 1.0.0
appVersion: latest
maintainers:
- name: diranged
email: [email protected]
dependencies:
- name: istio-alerts
version: 0.3.1
version: 0.4.0
repository: https://k8s-charts.nextdoor.com
condition: istio-alerts.enabled
- name: nd-common
Expand Down
16 changes: 14 additions & 2 deletions charts/rollout-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Argo Rollout-based Application Helm Chart

![Version: 0.8.0](https://img.shields.io/badge/Version-0.8.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)

[analysistemplate]: https://argoproj.github.io/argo-rollouts/features/analysis/?query=AnalysisTemplate#background-analysis
[argo_rollouts]: https://argoproj.github.io/argo-rollouts/
Expand All @@ -18,6 +18,18 @@ how these work, and the various custom resource definitions.

## Upgrade Notes

### 0.7.0 -> 1.0.0

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 0.2.x -> 0.3.x

**BREAKING: Istio Alerts have changed**
Expand Down Expand Up @@ -174,7 +186,7 @@ secretsEngine: sealed
| Repository | Name | Version |
|------------|------|---------|
| file://../nd-common | nd-common | 0.3.1 |
| https://k8s-charts.nextdoor.com | istio-alerts | 0.3.1 |
| https://k8s-charts.nextdoor.com | istio-alerts | 0.4.0 |

## Values

Expand Down
12 changes: 12 additions & 0 deletions charts/rollout-app/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,18 @@ how these work, and the various custom resource definitions.

## Upgrade Notes

### 0.7.0 -> 1.0.0

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 0.2.x -> 0.3.x

**BREAKING: Istio Alerts have changed**
Expand Down
2 changes: 1 addition & 1 deletion charts/simple-app/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ apiVersion: v2
name: simple-app
description: Default Microservice Helm Chart
type: application
version: 1.7.0
version: 1.7.1
appVersion: latest
maintainers:
- name: diranged
Expand Down
9 changes: 7 additions & 2 deletions charts/simple-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Default Microservice Helm Chart

![Version: 1.7.0](https://img.shields.io/badge/Version-1.7.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
![Version: 1.7.1](https://img.shields.io/badge/Version-1.7.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)

[deployments]: https://kubernetes.io/docs/concepts/workloads/controllers/deployment/
[hpa]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
Expand All @@ -13,13 +13,18 @@ defaults for you like the Kubernetes [Horizontal Pod Autoscaler][hpa].

## Upgrade Notes

### 1.2.x -> 1.7.x
### 1.6.x -> 1.7.x

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 1.1.2 -> 1.2.x

**BREAKING: Istio Alerts have changed**
Expand Down
8 changes: 6 additions & 2 deletions charts/simple-app/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,18 @@ defaults for you like the Kubernetes [Horizontal Pod Autoscaler][hpa].

## Upgrade Notes


### 1.2.x -> 1.7.x
### 1.6.x -> 1.7.x

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 1.1.2 -> 1.2.x

**BREAKING: Istio Alerts have changed**
Expand Down
4 changes: 2 additions & 2 deletions charts/stateful-app/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ apiVersion: v2
name: stateful-app
description: Default StatefulSet Helm Chart
type: application
version: 0.17.0
version: 1.0.0
appVersion: latest
maintainers:
- name: diranged
email: [email protected]
dependencies:
- name: istio-alerts
version: 0.3.1
version: 0.4.0
repository: https://k8s-charts.nextdoor.com
condition: istio-alerts.enabled
- name: nd-common
Expand Down
16 changes: 14 additions & 2 deletions charts/stateful-app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Default StatefulSet Helm Chart

![Version: 0.17.0](https://img.shields.io/badge/Version-0.17.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)
![Version: 1.0.0](https://img.shields.io/badge/Version-1.0.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: latest](https://img.shields.io/badge/AppVersion-latest-informational?style=flat-square)

[statefulsets]: https://kubernetes.io/docs/concepts/workloads/controllers/statefulset/
[hpa]: https://kubernetes.io/docs/tasks/run-application/horizontal-pod-autoscale/
Expand All @@ -13,6 +13,18 @@ ServiceAccounts, Services, etc.

## Upgrade Notes

### 0.7.0 -> 1.0.0

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 0.14.x -> 0.15.x

The `livenessProbe` and `readinessProbe` changes made in
Expand Down Expand Up @@ -266,7 +278,7 @@ secretsEngine: sealed
| Repository | Name | Version |
|------------|------|---------|
| file://../nd-common | nd-common | 0.3.1 |
| https://k8s-charts.nextdoor.com | istio-alerts | 0.3.1 |
| https://k8s-charts.nextdoor.com | istio-alerts | 0.4.0 |

## Values

Expand Down
12 changes: 12 additions & 0 deletions charts/stateful-app/README.md.gotmpl
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,18 @@ ServiceAccounts, Services, etc.

## Upgrade Notes

### 0.7.0 -> 1.0.0

**BREAKING: Istio Alerts have changed**

The Istio Alerts chart was updated to 4.0.0 which updates the alert on the 5XX
rate to only aggregate per service, rather than including the client source workload.

Additionally, it added an alert which will attempt to detect if your selector
criteria is valid or not. This requires kube-state-metrics to be installed and
can be disabled via your values file if you do not wish to install
kube-state-metrics.

### 0.14.x -> 0.15.x

The `livenessProbe` and `readinessProbe` changes made in
Expand Down

0 comments on commit b754c7b

Please sign in to comment.