Skip to content

Commit aab86e1

Browse files
jonathan-innisjonathan-innis
committed
Add podinfo chart
1 parent 438932c commit aab86e1

26 files changed

+1429
-0
lines changed

‎charts/podinfo/.helmignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Patterns to ignore when building packages.
2+
# This supports shell glob matching, relative path matching, and
3+
# negation (prefixed with !). Only one pattern per line.
4+
.DS_Store
5+
# Common VCS dirs
6+
.git/
7+
.gitignore
8+
.bzr/
9+
.bzrignore
10+
.hg/
11+
.hgignore
12+
.svn/
13+
# Common backup files
14+
*.swp
15+
*.bak
16+
*.tmp
17+
*~
18+
# Various IDEs
19+
.project
20+
.idea/
21+
*.tmproj

‎charts/podinfo/Chart.yaml‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
apiVersion: v1
2+
appVersion: 6.1.4
3+
description: Podinfo Helm chart for Kubernetes
4+
home: https://github.com/stefanprodan/podinfo
5+
kubeVersion: '>=1.19.0-0'
6+
maintainers:
7+
- email: stefanprodan@users.noreply.github.com
8+
name: stefanprodan
9+
name: podinfo
10+
sources:
11+
- https://github.com/stefanprodan/podinfo
12+
version: 6.1.4

‎charts/podinfo/LICENSE‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2018 Stefan Prodan. All rights reserved.
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎charts/podinfo/README.md‎

Lines changed: 123 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,123 @@
1+
# Podinfo
2+
3+
Podinfo is a tiny web application made with Go
4+
that showcases best practices of running microservices in Kubernetes.
5+
6+
Podinfo is used by CNCF projects like [Flux](https://github.com/fluxcd/flux2)
7+
and [Flagger](https://github.com/fluxcd/flagger)
8+
for end-to-end testing and workshops.
9+
10+
## Installing the Chart
11+
12+
To install the chart with the release name `my-release`:
13+
14+
```console
15+
$ helm repo add podinfo https://stefanprodan.github.io/podinfo
16+
17+
$ helm upgrade -i my-release podinfo/podinfo
18+
```
19+
20+
The command deploys podinfo on the Kubernetes cluster in the default namespace.
21+
The [configuration](#configuration) section lists the parameters that can be configured during installation.
22+
23+
## Uninstalling the Chart
24+
25+
To uninstall/delete the `my-release` deployment:
26+
27+
```console
28+
$ helm delete my-release
29+
```
30+
31+
The command removes all the Kubernetes components associated with the chart and deletes the release.
32+
33+
## Configuration
34+
35+
The following tables lists the configurable parameters of the podinfo chart and their default values.
36+
37+
Parameter | Default | Description
38+
--- | --- | ---
39+
`replicaCount` | `1` | Desired number of pods
40+
`logLevel` | `info` | Log level: `debug`, `info`, `warn`, `error`
41+
`backend` | `None` | Echo backend URL
42+
`backends` | `[]` | Array of echo backend URLs
43+
`cache` | `None` | Redis address in the format `tcp://<host>:<port>`
44+
`redis.enabled` | `false` | Create Redis deployment for caching purposes
45+
`ui.color` | `#34577c` | UI color
46+
`ui.message` | `None` | UI greetings message
47+
`ui.logo` | `None` | UI logo
48+
`faults.delay` | `false` | Random HTTP response delays between 0 and 5 seconds
49+
`faults.error` | `false` | 1/3 chances of a random HTTP response error
50+
`faults.unhealthy` | `false` | When set, the healthy state is never reached
51+
`faults.unready` | `false` | When set, the ready state is never reached
52+
`faults.testFail` | `false` | When set, a helm test is included which always fails
53+
`faults.testTimeout` | `false` | When set, a helm test is included which always times out
54+
`image.repository` | `stefanprodan/podinfo` | Image repository
55+
`image.tag` | `<VERSION>` | Image tag
56+
`image.pullPolicy` | `IfNotPresent` | Image pull policy
57+
`service.enabled` | `true` | Create a Kubernetes Service, should be disabled when using [Flagger](https://flagger.app)
58+
`service.type` | `ClusterIP` | Type of the Kubernetes Service
59+
`service.metricsPort` | `9797` | Prometheus metrics endpoint port
60+
`service.httpPort` | `9898` | Container HTTP port
61+
`service.externalPort` | `9898` | ClusterIP HTTP port
62+
`service.grpcPort` | `9999` | ClusterIP gPRC port
63+
`service.grpcService` | `podinfo` | gPRC service name
64+
`service.nodePort` | `31198` | NodePort for the HTTP endpoint
65+
`h2c.enabled` | `false` | Allow upgrading to h2c (non-TLS version of HTTP/2)
66+
`hpa.enabled` | `false` | Enables the Kubernetes HPA
67+
`hpa.maxReplicas` | `10` | Maximum amount of pods
68+
`hpa.cpu` | `None` | Target CPU usage per pod
69+
`hpa.memory` | `None` | Target memory usage per pod
70+
`hpa.requests` | `None` | Target HTTP requests per second per pod
71+
`serviceAccount.enabled` | `false` | Whether a service account should be created
72+
`serviceAccount.name` | `None` | The name of the service account to use, if not set and create is true, a name is generated using the fullname template
73+
`securityContext` | `{}` | The security context to be set on the podinfo container
74+
`linkerd.profile.enabled` | `false` | Create Linkerd service profile
75+
`serviceMonitor.enabled` | `false` | Whether a Prometheus Operator service monitor should be created
76+
`serviceMonitor.interval` | `15s` | Prometheus scraping interval
77+
`serviceMonitor.additionalLabels` | `{}` | Add additional labels to the service monitor |
78+
`ingress.enabled` | `false` | Enables Ingress
79+
`ingress.className ` | `""` | Use ingressClassName
80+
`ingress.annotations` | `{}` | Ingress annotations
81+
`ingress.hosts` | `[]` | Ingress accepted hosts
82+
`ingress.tls` | `[]` | Ingress TLS configuration
83+
`resources.requests.cpu` | `1m` | Pod CPU request
84+
`resources.requests.memory` | `16Mi` | Pod memory request
85+
`resources.limits.cpu` | `None` | Pod CPU limit
86+
`resources.limits.memory` | `None` | Pod memory limit
87+
`nodeSelector` | `{}` | Node labels for pod assignment
88+
`tolerations` | `[]` | List of node taints to tolerate
89+
`affinity` | `None` | Node/pod affinities
90+
`podAnnotations` | `{}` | Pod annotations
91+
92+
Specify each parameter using the `--set key=value[,key=value]` argument to `helm install`. For example,
93+
94+
```console
95+
$ helm install my-release podinfo/podinfo \
96+
--set=serviceMonitor.enabled=true,serviceMonitor.interval=5s
97+
```
98+
99+
To add custom annotations you need to escape the annotation key string:
100+
101+
```console
102+
$ helm upgrade -i my-release podinfo/podinfo \
103+
--set podAnnotations."appmesh\.k8s\.aws\/preview"=enabled
104+
```
105+
106+
Alternatively, a YAML file that specifies the values for the above parameters can be provided while installing the chart. For example,
107+
108+
```console
109+
$ helm install my-release podinfo/podinfo -f values.yaml
110+
```
111+
112+
> **Tip**: You can use the default [values.yaml](values.yaml)
113+
114+
## Upgrading the chart
115+
116+
### To =< 5.0.0
117+
118+
Version 5.0.0 is a major update.
119+
120+
* The chart now follows the new Kubernetes label recommendations:
121+
<https://kubernetes.io/docs/concepts/overview/working-with-objects/common-labels/>
122+
123+
The simplest way to update is to do a force upgrade, which recreates the resources by doing a delete and an install.

‎charts/podinfo/templates/NOTES.txt‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
1. Get the application URL by running these commands:
2+
{{- if .Values.ingress.enabled }}
3+
{{- range $host := .Values.ingress.hosts }}
4+
{{- range .paths }}
5+
http{{ if $.Values.ingress.tls }}s{{ end }}://{{ $host.host }}{{ .path }}
6+
{{- end }}
7+
{{- end }}
8+
{{- else if contains "NodePort" .Values.service.type }}
9+
export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ template "podinfo.fullname" . }})
10+
export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
11+
echo http://$NODE_IP:$NODE_PORT
12+
{{- else if contains "LoadBalancer" .Values.service.type }}
13+
NOTE: It may take a few minutes for the LoadBalancer IP to be available.
14+
You can watch the status of by running 'kubectl get svc -w {{ template "podinfo.fullname" . }}'
15+
export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ template "podinfo.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
16+
echo http://$SERVICE_IP:{{ .Values.service.externalPort }}
17+
{{- else if contains "ClusterIP" .Values.service.type }}
18+
echo "Visit http://127.0.0.1:8080 to use your application"
19+
kubectl -n {{ .Release.Namespace }} port-forward deploy/{{ template "podinfo.fullname" . }} 8080:{{ .Values.service.externalPort }}
20+
{{- end }}

0 commit comments

Comments
 (0)