Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove load_restrictor kustomize flag and lint README markdown #1844

Merged
merged 4 commits into from
Apr 16, 2021
Merged

Remove load_restrictor kustomize flag and lint README markdown #1844

merged 4 commits into from
Apr 16, 2021

Conversation

davidspek
Copy link
Contributor

Related to: #1797

Description of your changes:
This PR removes the load_restrictor flag from the README and the testing scripts as this flag should not be needed since #1840 has been merged. This allows Kustomize v3 and v4 to be used by users. This PR also fixes a few style inconsistencies in the README.

/cc @yanniszark I'm unsure if the approach for the Python and Go is correct. Also, the load_restrictor flag is still used in 2 places in the pipelines manifests which should be fixed upstream.

Checklist:

  • Unit tests pass:
    Make sure you have installed kustomize == 3.2.1
    1. make generate-changed-only
    2. make test

@google-cla google-cla bot added the cla: yes label Apr 14, 2021
yanniszark
yanniszark reviewed Apr 16, 2021
View reviewed changes
docs/KustomizeBestPractices.md
@@ -39,38 +39,6 @@ installs/
Defining separate packages for each component makes it easier to use composition to define new configurations; e.g. using an external database as opposed
to a database running in cluster.

## Reuse patches
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we keep this until we find a tested replacement?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I thought it would be best not to encourage people to do exactly what we have now spent time on removing from the manifests. We wouldn't want people creating manifests that essentially cause a regression before people have had the time to play with and test kustomize components.

Copy link
Contributor

@yanniszark yanniszark Apr 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

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

I agree that we want to move to components. The problem is we've had issues moving to kustomize v4: #1797
Does it make sense to leave a note here? That we want to move to components as an alternative to the load_restrictor flag, but can't do it yet because of #1797.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I believe #1797 can be closed as the Katib manifests have been merged. But I just pushed a commit that adds this section again with a note.

Copy link
Contributor

Choose a reason for hiding this comment

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

@davidspek we can't close #1797 yet. Please see:
#1797 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Right, my mistake. I'll look into that a bit more as well. How does the note look?

yanniszark
yanniszark reviewed Apr 16, 2021
View reviewed changes
hack/generate_tests.py Outdated Show resolved Hide resolved
yanniszark
yanniszark reviewed Apr 16, 2021
View reviewed changes
tests/test_util.go Outdated Show resolved Hide resolved
@yanniszark
Copy link
Contributor

@davidspek thanks a lot!
/lgtm
/approve

I also have an off-topic question. Did you use a linter for the markdown newlines or just elbow grease?
If it was a linter, it would be great to add it to our CI.

@google-oss-robot
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: DavidSpek, yanniszark

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-robot google-oss-robot merged commit 5fc7c7e into kubeflow:master Apr 16, 2021
@davidspek
Copy link
Contributor Author

@yanniszark For the Markdown linting I use the markdownlint VS-Code extension by David Anson. I went through it manually though to make sure it didn't make very large changes. We should see if this can be added to CI for this repo and others as I think that would give a much more consistent reading experience.

yanniszark pushed a commit to arrikto/kubeflow-manifests that referenced this pull request Apr 16, 2021
@davidspek @yanniszark
Remove load_restrictor kustomize flag and lint README markdown (kubef…
c30f852 
…low#1844)

* remove load-restrictor kustomize flag and lint README markdown

* Set kustomize loader to RestrictionRootOnly in test_util.go

* review: undo changes to test scripts

* review: add note to reusing patches best practices
google-oss-robot pushed a commit that referenced this pull request Apr 17, 2021
@yanniszark @Bobgy
@pvaneck @andreyvelich @davidspek
Cherry-pick commits to v1.3-branch (#1849)
f4d4aac 
* chore: remove argo manifests from contrib (#1813)

* Make note of knative-eventing being optional in README  (#1826)

Only Knative Serving is required for KFServing to work.
Knative Eventing is used for specific logger/metrics tracking
use cases, so a note is made in the README about eventing
being optional.

* README: Expand section for connecting to a Kubeflow cluster (#1841)

The current section for connecting to a Kubeflow cluster only covers
connecting with port-forward. Expand the section with instructions for
NodePort / LoadBalancer / Ingress.

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Sync Katib manifests with Kustomize v4 support (#1840)

* Kubeflow Tekton Pipelines: Sync manifests (#1843)

Sync manifests for application "Kubeflow Tekton Pipelines".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kfp-tekton
- Path: manifests/kustomize
- Revision: v0.8.0-rc0

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Sync wg-notebooks apps to revision 1.3.0-rc.1 (#1846)

* Notebook Controller: Sync manifests

Sync manifests for application "Notebook Controller".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/notebook-controller/config
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Tensorboard Controller: Sync manifests

Sync manifests for application "Tensorboard Controller".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/tensorboard-controller/config
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Central Dashboard: Sync manifests

Sync manifests for application "Central Dashboard".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/centraldashboard/manifests
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Profiles + KFAM: Sync manifests

Sync manifests for application "Profiles + KFAM".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/profile-controller/config
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* PodDefaults Webhook: Sync manifests

Sync manifests for application "PodDefaults Webhook".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/admission-webhook/manifests
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Jupyter Web App: Sync manifests

Sync manifests for application "Jupyter Web App".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/crud-web-apps/jupyter/manifests
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Tensorboards Web App: Sync manifests

Sync manifests for application "Tensorboards Web App".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/crud-web-apps/tensorboards/manifests
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Volumes Web App: Sync manifests

Sync manifests for application "Volumes Web App".
Upstream manifests are copied from:
- Repo: https://github.com/kubeflow/kubeflow
- Path: components/crud-web-apps/volumes/manifests
- Revision: 8901e3af3b83f599b89562162cdb2854f57082d3

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* Remove load_restrictor kustomize flag and lint README markdown (#1844)

* remove load-restrictor kustomize flag and lint README markdown

* Set kustomize loader to RestrictionRootOnly in test_util.go

* review: undo changes to test scripts

* review: add note to reusing patches best practices

* README: Add component version matrix (#1847)

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* README: Add FAQ, elaborate kustomize version, update version matrix (#1848)

* README: Add FAQ section and justify kustomize version

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

* README: Update version matrix

Signed-off-by: Yannis Zarkadas <yanniszark@arrikto.com>

Co-authored-by: Yuan (Bob) Gong <4957653+Bobgy@users.noreply.github.com>
Co-authored-by: Paul Van Eck <pvaneck@us.ibm.com>
Co-authored-by: Andrey Velichkevich <andrey.velichkevich@gmail.com>
Co-authored-by: DavidSpek <vanderspek.david@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@yanniszark yanniszark yanniszark left review comments

@elikatsis elikatsis Awaiting requested review from elikatsis

Assignees

@yanniszark yanniszark

Labels
approved cla: yes lgtm size/M
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@davidspek @yanniszark @google-oss-robot