Skip to content
This repository has been archived by the owner on Mar 16, 2021. It is now read-only.

deploy: add README, fix typos #124

Merged
merged 1 commit into from
Dec 7, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions deploy/hostpath/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
The .yaml files in this directory depend on the RBAC files that were
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the rbac rules should be copied into examples/hostpath so that a hostpath deployment can be done using the YAML files. The docs will eventually point to the hostpath repos.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, please not. Having to keep files in sync in different repos is exactly the kind of maintenance headache that we are currently trying to get rid of.

The Example.md is self-contained without copies because it references upstream files via URL. I have a PR pending for Kubernetes E2E which achieves the same (kubernetes/kubernetes#71703). Let's not go in the other direction here.

The deployment here won't be complete, but it doesn't have to be. That's what the Example.md is for - IMHO.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

FWIW, I personally would have preferred a solution where all relevant .yaml files are in the same repo because then they can be updated and tested together. But it was decided that each component maintainer is also responsible for maintaining the corresponding .yaml files (in particular the RBAC files), which is why we now move the individual files away from centralized places (docs, kubernetes E2E) into individual repos.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree with your last comment re: having all yamls in the same repo. My thought was to have all yamls that are necessary to standup a hostpath instance under hostpath/example instead of docs/examples to minimize. I think when the config yamls are located in docs/examples, it may not be clear that they need updated as hostpath changes.

Copy link
Contributor Author

@pohly pohly Dec 5, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moving from kubernetes-csi/docs is good. Then eventually kubernetes-csi/docs will just reference files elsewhere by URL.

But do you really mean all yamls, including the RBAC ones from driver-registrar, external-attacher and external-provisioner? That goes against the decision made earlier, so before you do that, discuss it in the CSI standup.

In the meantime, can we merge this PR?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should leave RBAC files in sidecar container repos (external-provisioner, external-attacher, etc.).
Each driver can provide it's own YAMLs for DeamonSet/ReplicaSet, along with a deployment script that deploys all the YAMLs (including the RBAC ones).

released together the CSI sidecar containers. Check the repos and/or
release notes for the CSI sidecar containers for details.

https://kubernetes-csi.github.io/docs/ has an example that puts all
pieces together.
2 changes: 1 addition & 1 deletion deploy/hostpath/csi-hostpathplugin.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ spec:
labels:
app: csi-hostpathplugin
spec:
serviceAccountName: csi-node-sa
serviceAccountName: csi-driver-registrar
hostNetwork: true
containers:
- name: driver-registrar
Expand Down