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

update the tilt doc with screenshots #1633

Merged
merged 2 commits into from
Aug 21, 2021
Merged

update the tilt doc with screenshots #1633

merged 2 commits into from
Aug 21, 2021

Conversation

sonasingh46
Copy link
Contributor

/kind documentation

What this PR does / why we need it:
This PR adds tilt screenshot to deploy flavor workload cluster so as to give more clarity for the first time contributors.

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #1618

Special notes for your reviewer:

TODOs:

  • squashed commits
  • includes documentation
  • adds unit tests

Release note:

None

@k8s-ci-robot k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Aug 20, 2021
@k8s-ci-robot
Copy link
Contributor

Welcome @sonasingh46!

It looks like this is your first PR to kubernetes-sigs/cluster-api-provider-azure 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/cluster-api-provider-azure has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot
Copy link
Contributor

Hi @sonasingh46. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /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.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Aug 20, 2021
@k8s-ci-robot k8s-ci-robot added area/provider/azure Issues or PRs related to azure provider sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 20, 2021
mboersma
mboersma reviewed Aug 20, 2021
View reviewed changes
templates/flavors/README.md Outdated
@@ -36,7 +33,13 @@ Please note your tilt-settings.json must contain at minimum the following fields
}
}
```
After having the tilt-settings.json, follow these two steps to deploy a workload cluster
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
After having the tilt-settings.json, follow these two steps to deploy a workload cluster
After updating tilt-settings.json, follow these two steps to deploy a workload cluster:

templates/flavors/README.md Outdated

1. ``tilt up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.json also resides here in the
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
1. ``tilt up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.json also resides here in the
1. Run ``make tilt-up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.json also resides here in the

templates/flavors/README.md Outdated

1. ``tilt up`` in the root of cluster-api-provider-azure repo. Note that the tilt-settings.json also resides here in the
root of this repo. After this, press `space` to open the tilt UI in browser. See the following example:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
root of this repo. After this, press `space` to open the tilt UI in browser. See the following example:
root of this repo. After tilt has initialized, press `space` to open the tilt web UI in a browser. See the following example:

docs/book/src/developers/development.md Outdated
@@ -217,9 +215,10 @@ The cluster-api management components that are deployed are configured at the `/

⚠️ Note that when developing with `tilt` as described above, some `clusterctl` commands won't work. Specifically, `clusterctl config` and `clusterctl generate` may fail. These commands expect specific releases of CAPI and CAPZ to be installed, but the `tilt` environment dynamically updates and installs these components from your local code. `clusterctl get kubeconfig` will still work, however.

After your kind management cluster is up and running with Tilt, you can [configure workload cluster settings](#customizing-the-cluster-deployment) and deploy a workload cluster by opening the `tilt` web UI and clicking the clockwise arrow icon ⟳ on a resource listed, such as "aks-aad," "ipv6," or "windows."
After your kind management cluster is up and running with Tilt, you can deploy a workload cluster by opening the `tilt` web UI and clicking the clockwise arrow icon ⟳ on a resource listed, such as "aks-aad," "ipv6," or "windows."
Deploying a workload cluster from Tilt UI is also termed as flavor cluster deployment. Please refer [here](../../../../templates/flavors/README.md#Running-flavor-clusters-as-a-tilt-resource) to learn more about this.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Deploying a workload cluster from Tilt UI is also termed as flavor cluster deployment. Please refer [here](../../../../templates/flavors/README.md#Running-flavor-clusters-as-a-tilt-resource) to learn more about this.
Please refer to [Running flavor clusters as a tilt resource](../../../../templates/flavors/README.md#Running-flavor-clusters-as-a-tilt-resource) to learn more about this.

@CecileRobertMichon
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Aug 20, 2021
mboersma
mboersma approved these changes Aug 20, 2021
View reviewed changes
Copy link
Contributor

@mboersma mboersma left a comment

Choose a reason for hiding this comment

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

/lgtm

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Aug 20, 2021
@CecileRobertMichon
Copy link
Contributor

@Jont828 would be great to get your review on this since you went through the process of setting up tilt for the first time recently

@Jont828
Copy link
Contributor

Jont828 commented Aug 20, 2021

Looks good, having the expected output and showing the arrow icon will definitely help! /lgtm

@CecileRobertMichon
Copy link
Contributor

/approve

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: CecileRobertMichon

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 added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 20, 2021
@sonasingh46
Copy link
Contributor Author

/retest

@k8s-ci-robot k8s-ci-robot merged commit 71c62e7 into kubernetes-sigs:main Aug 21, 2021
@sonasingh46 sonasingh46 mentioned this pull request Jan 25, 2022
Closed
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mboersma mboersma mboersma approved these changes

@shysank shysank Awaiting requested review from shysank

Assignees

@mboersma mboersma

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/provider/azure Issues or PRs related to azure provider cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/documentation Categorizes issue or PR as related to documentation. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. sig/cluster-lifecycle Categorizes an issue or PR as relevant to SIG Cluster Lifecycle. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Improve Tilt docs about using built in flavor resources
5 participants
@sonasingh46 @k8s-ci-robot @CecileRobertMichon @Jont828 @mboersma