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

Add example for kustomize build {url} and remote bases #264

Merged
merged 1 commit into from
Aug 20, 2018

Conversation

Liujingfang1
Copy link
Contributor

@Liujingfang1 Liujingfang1 commented Aug 16, 2018

Fix #254

  • Updated docs in types.go, kustomization.yaml, glossary.md and kustomize build --help
  • Add remoteBuild.md wtih two examples
    • kustomize build {url}
    • remote bases

@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Liujingfang1

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 approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 16, 2018
@Liujingfang1 Liujingfang1 force-pushed the docs branch 2 times, most recently from 3888dfc to 816bee8 Compare August 16, 2018 20:45
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 16, 2018
@Liujingfang1 Liujingfang1 changed the title Add example for kustomize build {url} Add example for kustomize build {url} and remote bases Aug 16, 2018


The url should follow
[hashicorp/go-getter URL format](https://github.com/hashicorp/go-getter#url-format)
Copy link
Contributor

Choose a reason for hiding this comment

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

Missing a period at end of sentence.


## kustomize build {URL}

`kustomize build` can be run against a url. The effect is the same as cloing the repo, checking out the specified ref,
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 entire doc here should start with this sentence.

The current first section offers a list of example URLs. That would be better at the end.

test 3 == \
$(kustomize build github.com/kubernetes-sigs/kustomize//examples/multibases?ref=v1.0.6 | grep cluster-a-.*-myapp-pod | wc -l); \
echo $?
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Great example. Suggest making it more legible, e.g.

target=github.com/kubernetes-sigs/kustomize//examples/multibases?ref=v1.0.6
test 3 == \
  $(kustomize build $target | grep cluster-a-.*-myapp-pod | wc -l); \
  echo $?

## remote {URL} in bases

Similarly, the remote url can be used as a base in an overlay. Take the same url `github.com/kubernetes-sigs/kustomize//examples/multibases?ref=v1.0.6` as an example.
An overaly can be simpliy created on top of it.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest shortening this to just:

A base can also be specified as a URL:

test 3 == \
$(kustomize build $DEMO_HOME | grep remote-.*-myapp-pod | wc -l); \
echo $?
```
Copy link
Contributor

Choose a reason for hiding this comment

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

Nice job.

@Liujingfang1
Copy link
Contributor Author

Updated the example according to comments. PTAL @monopole

Copy link
Contributor

@monopole monopole 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, 2018
@k8s-ci-robot k8s-ci-robot merged commit 1ffeb18 into kubernetes-sigs:master Aug 20, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants