[stable] Add IPFS Chart #1192

yuvipanda · 2017-05-29T18:27:10Z

Adds a chart that lets you install IPFS with a StatefulSet.

- Uses persistent volumes for the IPFS Path, so we retain objects across restarts. - Uses a StatefulSet rather than Deployment, since we want a PVC for each pod running. Using a StatefulSet lets us scale up and down without sacrificing a persistent cache.

k8s-ci-robot · 2017-05-29T18:27:17Z

Hi @yuvipanda. Thanks for your PR.

I'm waiting for a kubernetes member to verify that this patch is reasonable to test. If it is, they should reply with @k8s-bot ok to test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

victorb · 2017-05-29T18:32:16Z

stable/ipfs/templates/statefulset.yaml

+        runAsUser: 1000
+      containers:
+      - name: {{ .Chart.Name }}
+        image: jbenet/go-ipfs:release 


Probably want to use ipfs/go-ipfs instead of from Juan's account, and also lock it to a version, v0.4.9 is latest available in Docker Hub.

Good catch! Fixed it :)

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/service.yaml

+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ if .Values.service.nameOverride }} {{ .Values.service.nameOverride }} {{ else }} {{ template "fullname" . }} {{ end }}


Why would you want to do that? This should just be {{ template "fullname" . }}.

Because I want to be allow users to override service names. In this case, end users will be asked to hit the DNS entry for the service name, and that should be overrideable so it can be something like 'ipfs' so other users in the same namespace can just specify 'ipfs'. The default is still the behavior seen in the current charts in the repo.

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/statefulset.yaml

+apiVersion: apps/v1beta1
+kind: StatefulSet
+metadata:
+  name: {{ template "name" . }}


Name should be {{ template "fullname" . }}.

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/statefulset.yaml

+  template:
+    metadata:
+      labels:
+        app: {{ template "fullname" . }}


Use this {{ template "name" . }} for the app label.

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/statefulset.yaml

+      labels:
+        app: {{ template "fullname" . }}
+    spec:
+      securityContext:


Can you explain the reason behind this?

Yes - the image needs to write to the PVC to function, and it runs as UID 1000 (rather than root).

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/statefulset.yaml

+        runAsUser: 1000
+      containers:
+      - name: {{ .Chart.Name }}
+        image: ipfs/go-ipfs:v0.4.9


Make image configurable.

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/values.yaml

+  nameOverride: null
+
+resources:
+  requests:


Don't specify defaults for resources.

unguiculus · 2017-05-30T17:03:01Z

stable/ipfs/templates/service.yaml

+metadata:
+  name: {{ if .Values.service.nameOverride }} {{ .Values.service.nameOverride }} {{ else }} {{ template "fullname" . }} {{ end }}
+  labels:
+    chart: "{{ .Chart.Name }}-{{ .Chart.Version | replace "+" "_" }}"


Use standard labels everywhere. See:
https://github.com/kubernetes/helm/blob/master/docs/chart_best_practices/labels.md

I just got this from helm create, will read and update!

unguiculus · 2017-05-30T17:05:40Z

stable/ipfs/templates/statefulset.yaml

+spec:
+  replicas: {{ .Values.replicaCount }}
+  serviceName: {{ template "name" . }}
+  volumeClaimTemplates:


Could you make this more flexible and make persistence optional?
See e. g.: https://github.com/kubernetes/charts/blob/master/stable/mongodb-replicaset/templates/mongodb-statefulset.yaml#L175-L199

I could if it is a requirement for merging :) but it's not particularly useful without persistent volumes however - but I guess so is the case for MongoDB!

Done! Optional but enabled by default!

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/values.yaml

@@ -1,14 +1,14 @@
 replicaCount: 1

+image: ipfs/go-ipfs:v0.4.9
+
 service:
  type: ClusterIP
  nameOverride: null


Remove nameOverride: null

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/service.yaml

+    targetPort: 8080
+    name: gateway
+  selector:
+    app: {{ template "name" . }}


Requires an additional selector: release: {{ .Release.Name }}

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/statefulset.yaml

+  template:
+    metadata:
+      labels:
+        app: {{ template "name" . }}


At least the release label should be added here as well.

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/statefulset.yaml

+        volumeMounts:
+          - name: ipfs-storage
+            mountPath: /data/ipfs
+        {{- if .Values.resources }}


if not necessary. Add default to values.yaml:

resources: {}

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/values.yaml

+
+service:
+  type: ClusterIP
+  nameOverride: null


Remove nameOverride.

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/statefulset.yaml

+    spec:
+      securityContext:
+        # The image runs as uid 1000 by default, and needs to be able to write to
+        # the persistent volume to be able to start.


I don't think this is necessary. Will test this. Otherwise we'd have this problem with lots of charts. I think this is only a problem if you mount a volume from the host, which is not the case.

I ran into permissionDenied errors when I tried (on GKE). Perhaps the runAsUser isn't necessary but fs is?

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/_helpers.tpl

+could just connect to it by specifying 'ipfs'.
+*/}}
+{{- define "servicename" -}}
+{{- if .Values.service.nameOverride -}}


Add truncation.

On second thought, am not sure this needs truncation. The user is responsible for setting it, and the default fullname handles truncation already.

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/README.md

+| `replicaCount` | The number of replicas of go-ipfs to run | 1 |
+| `service.type` | Type of the service: `ClusterIP`, `LoadBalancer` or `NodePort` | `ClusterIP` |
+| `service.nameOverride` | The name to use for the service | The full name of the release |
+| `storage.size` | Size of the PVC for each IPFS pod, used as persistent cache | `10Gi` |


Add missing config entries.

unguiculus · 2017-05-30T18:36:22Z

stable/ipfs/templates/service.yaml

+    heritage: {{ .Release.Service }}
+    release: {{ .Release.Name }}
+spec:
+  type: {{ .Values.service.type }}


Statefulsets require a headless service. This means you should always have this:

type: ClusterIP clusterIP: None

Does the service need to be headless? We also need a service anyway, and this paradigm works well - ipfs.namespace round robins to one of them, and you can do ipfs-0.ipfs or ipfs-1.ipfs for each one if you need.

unguiculus · 2017-05-30T19:21:16Z

@k8s-bot ok to test

yuvipanda · 2017-06-04T01:16:34Z

Anything else I need to do before I can get it merged? :)

unguiculus

I deployed it on GKE. Everything seems to come up successfully. The log looks ok. When I access it on port 8080 with port-forwarding, I get a 404.

unguiculus · 2017-06-13T20:07:08Z

stable/ipfs/templates/NOTES.txt

+{{- else if contains "ClusterIP"  .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app={{ template "fullname" . }}" -o jsonpath="{.items[0].metadata.name}")
+  echo "Visit http://127.0.0.1:8080 to use your application"
+  kubectl port-forward $POD_NAME 8080:{{ .Values.service.externalPort }}


service.externalPort is not used anywhere. Thus, a default installation prints this:

If you want to connect to it from your local computer, you can find a URL to connect with the following (for the gateway service): export POD_NAME=$(kubectl get pods --namespace default -l "app=wiggly-alpaca-ipfs" -o jsonpath="{.items[0].metadata.name}") echo "Visit http://127.0.0.1:8080 to use your application" kubectl port-forward $POD_NAME 8080:

Also note that the label selector is wrong. Use this: -l "app={{ template "name" . }},release={{ .Release.Name }}"

unguiculus · 2017-07-02T18:06:20Z

Marking as stale. Please update within one week.

yuvipanda · 2017-07-02T19:04:00Z

Whoops, shall do! On Jul 2, 2017 11:06 AM, "Reinhard Nägele" <notifications@github.com> wrote: Marking as stale. Please update within one week. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#1192 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AAB23v0WR0qhC1W-eEsAtaXrd2EI7Z81ks5sJ9wdgaJpZM4Npi2Z> .

yuvipanda · 2017-07-10T03:22:12Z

The 404 is expected, since it's only an API Gateway service. If you access, for example, /ipfs/Qmb8wsGZNXt5VXZh1pEmYynjB6Euqpq3HYyeAdw2vScTkQ, it'll lead you to the same page as https://ipfs.io/ipfs/Qmb8wsGZNXt5VXZh1pEmYynjB6Euqpq3HYyeAdw2vScTkQ. It can also serve a particular hash based on a Host Header. For example, if you do a curl -H 'Host: ipfs.io' <ip> you'll actually get back the contents of ipfs.io landing page.

unguiculus · 2017-07-11T19:58:28Z

@yuvipanda

Two things about the Chart.yaml I noticed after merging:

The maintainer name should be a Github user
The appVersion field should be added

Would you mind creating another PR for this?

* upstream/master: Add IPFS Chart (helm#1192) [stable/ghost] Release 0.4.12 (helm#1429) [stable/opencart] Release 0.4.10 (helm#1425) [stable/redmine] Release 1.2.0 (helm#1414) [stable/wordpress] Release 0.6.8 (helm#1403) [stable/rabbitmq] Release 0.5.4 (helm#1395) [stable/mongodb] Release 0.4.12 (helm#1392) [stable/phabricator] Release 0.4.11 (helm#1384) [stable/drupal] Release 0.8.1 (helm#1340) [stable/odoo] Release 0.5.3 (helm#1323) update pilot svc name to default for nicer UX (helm#1464) [stable/grafana] Improve curl invocation (helm#1463)

yuvipanda · 2017-07-12T18:10:31Z

@unguiculus I sent #1469. Thanks!

yuvipanda added 5 commits May 29, 2017

[stable/ipfs] Initial version

b6226ed

- Uses persistent volumes for the IPFS Path, so we retain objects across restarts. - Uses a StatefulSet rather than Deployment, since we want a PVC for each pod running. Using a StatefulSet lets us scale up and down without sacrificing a persistent cache.

Add more info to Chart.yaml

aa67095

Add NOTES file

7d60b01

Add README

7af2f92

Clean up templates to match README

78aa59f

k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 29, 2017

victorb reviewed May 29, 2017

View changes

[stable/ipfs] Use the official docker image

058fb3e

unguiculus suggested changes May 30, 2017

View changes

unguiculus self-assigned this May 30, 2017

unguiculus reviewed May 30, 2017

View changes

yuvipanda added 9 commits May 30, 2017

[stable/ipfs] Use a template for specifying service name

b92edc6

[stable/ipfs] Use servicename template in NOTES too

5c3978c

[stable/ipfs] Use fullname rather than name for statefulset names

426fccd

[stable/ipfs] Don't specify resource requests by default

14c4a96

[stable/ipfs] Make image configurable

7d14b02

[stable/ipfs] Use name template for app selectors

149a31a

[stable/ipfs] Specify standard labels on deployment + service

a5bc12f

[stable/ipfs] Add comment about uids

ce87bc6

[stable/ipfs] Make persistence optional

b41eb59

unguiculus suggested changes May 30, 2017

View changes

yuvipanda added 3 commits May 30, 2017

[stable/ipfs] Don't add a null override for nameOverride

e89404f

[stable/ipfs] Specify default resource requests in values.yaml

e6017b4

[stable/ipfs] Add more standard labels

97f49ca

k8s-ci-robot removed the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label May 30, 2017

unguiculus approved these changes May 30, 2017

View changes

[stable/ipfs] Document all the options available

4e75c33

unguiculus added the code reviewed label Jun 12, 2017

unguiculus suggested changes Jun 13, 2017

View changes

unguiculus added the stale label Jul 2, 2017

[stable/ipfs] Clarify NOTES.txt

b36d1a2

unguiculus added UX reviewed and removed stale labels Jul 11, 2017

unguiculus merged commit a78cbd1 into helm:master Jul 11, 2017
2 checks passed

yuvipanda deleted the ipfs branch Jul 12, 2017

yanns pushed a commit to yanns/charts that referenced this issue Jul 28, 2017

Add IPFS Chart (helm#1192)

fb7dfa3

[stable] Add IPFS Chart #1192

[stable] Add IPFS Chart #1192

Conversation

yuvipanda commented May 29, 2017

k8s-ci-robot commented May 29, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unguiculus commented May 30, 2017

yuvipanda commented Jun 4, 2017

unguiculus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unguiculus commented Jul 2, 2017

yuvipanda commented Jul 2, 2017

yuvipanda commented Jul 10, 2017

unguiculus commented Jul 11, 2017

yuvipanda commented Jul 12, 2017