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.

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

Migrate all KFDefs to use Kustomize v3 patterns #1062

Closed
jlewi opened this issue Mar 30, 2020 · 3 comments
Closed

Migrate all KFDefs to use Kustomize v3 patterns #1062

jlewi opened this issue Mar 30, 2020 · 3 comments

Comments

@jlewi
Copy link
Contributor

jlewi commented Mar 30, 2020

Ref: http://bit.ly/kf_kustomize_v3
#744

KFDef patterns should follow kf_kustomize_v3 patterns. This means

  1. Applications in KFDef should not use the overlays or parameters field
  2. There should be an application named "kubeflow-apps" that is a kustomize package
  3. Applications should fetch global paramaters from the configmap "kubeflow-config"
  4. Applications should fetch application parameters from application specific config maps
  5. Use of vars should be minimized
    • The most common and supported use case should be to substitute parameters into
      fields that don't support referencing a configmap directly
    • In this case var names should be unique enough that they won't conflict with vars from
      other applications

We should create an example e.g. #962 and then file PRs to update all the individual KFDef.

We will also need to update all the applications.

@jlewi jlewi added this to To do in Kubeflow 1.1 via automation Mar 30, 2020
@jlewi jlewi added this to To do in kustomize-v3 via automation Mar 30, 2020
@issue-label-bot
Copy link

Issue-Label Bot is automatically applying the labels:

Label Probability
kind/feature 0.96

Please mark this comment with 👍 or 👎 to give our bot feedback!
Links: app homepage, dashboard and code for this bot.

jlewi pushed a commit to jlewi/manifests that referenced this issue Apr 15, 2020
* For default-install we need to change the name of the configmap to match
  the configmap that will be generated by kfctl.

Related to kubeflow#1062
k8s-ci-robot pushed a commit that referenced this issue Apr 16, 2020
* Add default-install

* Convert default-install to v3.

* For default-install we need to change the name of the configmap to match
  the configmap that will be generated by kfctl.

Related to #1062

* * Modify spartakus to work with v3 and stacks; we need to change the
  config map name to match the config map generated by kfctl with
  application parameters.

* Include kubeflow-roles.

* Fix and regenerate the tests.

* To fix the tests we need to change the name of the config maps.
jlewi pushed a commit to jlewi/manifests that referenced this issue Apr 30, 2020
* See http://bit.ly/kf_kustomize_v3

* Its been over a year since we started migrating to kustomize. In that time
kustomize has evolved and we have learned a lot about how to use
kustomize effectively.

* Some of the initial usage patterns have turned out to be problematic (e.g. vars) and there are now better options.

* Update the style guide to better document best practices.

Related to kubeflow#1062
@jlewi
Copy link
Contributor Author

jlewi commented May 7, 2020

/cc @animeshsingh

k8s-ci-robot pushed a commit that referenced this issue May 7, 2020
…1144)

* Create an updated style/best practices guide for kustomize packages.

* See http://bit.ly/kf_kustomize_v3

* Its been over a year since we started migrating to kustomize. In that time
kustomize has evolved and we have learned a lot about how to use
kustomize effectively.

* Some of the initial usage patterns have turned out to be problematic (e.g. vars) and there are now better options.

* Update the style guide to better document best practices.

Related to #1062

* Fix.

* Address comments.
jlewi pushed a commit to jlewi/manifests that referenced this issue Jun 9, 2020
* For GCP will not be using KFDef with 1.1; instead we will be using
  blueprints (see kubeflow#1063)

* Therefore I updated the existing example of deploying using stacks
  to make it non GCP specific so that it could be used as an example
  for platforms that still want to use KFDef.

  * kubeflow#1062 is tracking migrating all KFDefs to the new versions
    of our kustomize packages
k8s-ci-robot pushed a commit that referenced this issue Jun 10, 2020
* For GCP will not be using KFDef with 1.1; instead we will be using
  blueprints (see #1063)

* Therefore I updated the existing example of deploying using stacks
  to make it non GCP specific so that it could be used as an example
  for platforms that still want to use KFDef.

  * #1062 is tracking migrating all KFDefs to the new versions
    of our kustomize packages
@jlewi
Copy link
Contributor Author

jlewi commented Jun 15, 2020

Closing this issue; we have sub issues tracking the remaining work.

@jlewi jlewi closed this as completed Jun 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Kubeflow 1.1
  
Done
kustomize-v3
  
To do
Development

No branches or pull requests

1 participant