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

update release doc #3968

Merged
merged 10 commits into from Sep 25, 2019
Merged

update release doc #3968

merged 10 commits into from Sep 25, 2019

Conversation

gabrielwen
Copy link
Contributor

@gabrielwen gabrielwen commented Aug 21, 2019

Adding instructions for joining release team and updating application version.


This change is Reviewable

docs_dev/releasing.md Outdated Show resolved Hide resolved
docs_dev/releasing.md Outdated Show resolved Hide resolved
@jlewi
Copy link
Contributor

jlewi commented Aug 21, 2019

@gabrielwen Could you do a pass through the release doc please and update any sections that no longer make sense; there is a lot of outdated information.

I think it would be great to talk about the following

  1. How to prepare individual applications for release

    • e.g. for TFJob and PYtorch; cut release branches for those applications
    • Update kubeflow/manifests master to use them
  2. How to cut a release branch of kubeflow/manifests and prepare it for relesae

    • e.g. update the Kubeflow application resource version to the upcoming major.minor release
  3. How to cut a kfctl release

    • e.g. cut the branch; update releases etc.
  4. How to update the KFDef specs on the release branch

    * The repos section should be pinned to specific commits on the release branch
    

We can also delete a bunch of outdated references to ksonnet
e.g. update or delete all references to ksonnet; e.g. the section Updating ksonnet prototypes with docker image and the section "Updating the ksonnet configs for master"

@jlewi
Copy link
Contributor

jlewi commented Aug 28, 2019

We should also add some steps about looking at the test grid to ensure tests are passing.

  • It looks like one thing we need to document is that the tests on the release branch need to be updated to use the configs from the release branch.

@gabrielwen gabrielwen changed the title update release doc [WIP] update release doc Sep 3, 2019
@jlewi
Copy link
Contributor

jlewi commented Sep 10, 2019

@gabrielwen Think we can wrap this up this week?

@gabrielwen
Copy link
Contributor Author

Yes, we should be able to. I forgot what I was trying to add to, but will finish this up this week.

@gabrielwen gabrielwen changed the title [WIP] update release doc update release doc Sep 17, 2019
@gabrielwen
Copy link
Contributor Author

@jlewi should be ready, could you take a look? thanks.

@jlewi
Copy link
Contributor

jlewi commented Sep 18, 2019

@gabrielwen see my previous comment it looks like we are still missing a bunch of information.

Here's my meta comment. Can we try to define a clear process that would be easy for someone to follow?

Lets add a section about releasing all the individual components

In this section lets create a list of all the components that should be updated as part of each release

  • TFJob
  • PyTorch
  • JupyterWebapp
  • CentralDashboard
  • Katib
  • ProfileController
  • NotebookController

The instructions should say something like the following

  1. Create release branch for all of the above
  2. Create a Kubernetes periodic prow job for the release branch
  3. Update the prow_config.yaml on the release branch if necessary
    • i.e. kfctl v0.Y-branch should pull in v0.Y branch of kubeflow-manifests
  4. Check that postsubmits on the branch are green
  5. Build and publish docker images to gcr.io/kubeflow-images-public for all of the above
  6. Update kustomize manifest on kubeflow/manifest to reference the above

Once all of the application manifests on kubeflow/master have been updated we are ready to cut a release branch

Once we cut the release branch of kubeflow/manifests lets list out all the steps that need to be performed

  1. Create a periodic prow job
  2. Update prow_config to use the v0.Y branch of kfctl
  3. Update application version in all applications

@jlewi
Copy link
Contributor

jlewi commented Sep 19, 2019

@gabrielwen let me know when this is ready for another look?

@gabrielwen
Copy link
Contributor Author

working on this now.

@gabrielwen
Copy link
Contributor Author

@jlewi updated, could you also take a look? I'll also take second pass tonight.

@jlewi
Copy link
Contributor

jlewi commented Sep 25, 2019

This is great; thanks @gabrielwen

/lgtm
/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jlewi

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

@k8s-ci-robot k8s-ci-robot merged commit 6a0fd60 into kubeflow:master Sep 25, 2019
nrchakradhar pushed a commit to nrchakradhar/kubeflow that referenced this pull request Sep 30, 2019
* update release doc

* update doc

* update stale docs

* update docs

* add image in manifests

* add config versions

* update release doc

* add doctoc
saffaalvi pushed a commit to StatCan/kubeflow that referenced this pull request Feb 11, 2021
* update release doc

* update doc

* update stale docs

* update docs

* add image in manifests

* add config versions

* update release doc

* add doctoc
saffaalvi pushed a commit to StatCan/kubeflow that referenced this pull request Feb 12, 2021
* update release doc

* update doc

* update stale docs

* update docs

* add image in manifests

* add config versions

* update release doc

* add doctoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants