Update supported URLs in remoteBuild.md #4030

thatsmydoing · 2021-07-02T05:17:07Z

Since kustomize no longer bundles go-getter, I've updated the documentation to reflect that. I also took the liberty of more narrowly defining what the supported URL format is. The goal is to minimize confusion for users and to have a potential avenue to remove the "go-getter" format.

I only updated the file in the examples/ directory as I presume the docs/ directory is deprecated in favor of https://github.com/kubernetes-sigs/cli-experimental if this looks good I can submit a PR for updating those docs too.

k8s-ci-robot · 2021-07-02T05:17:14Z

Hi @thatsmydoing. 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.

thatsmydoing · 2021-07-02T05:18:45Z

examples/zh/remoteBuild.md

@@ -9,7 +9,7 @@
 <!-- @remoteOverlayBuild @test -->

 ```bash
-target="github.com/kubernetes-sigs/kustomize/examples/multibases/dev/?ref=v1.0.6"
+target="https://github.com/kubernetes-sigs/kustomize//examples/multibases/dev/?ref=v1.0.6"


This file is technically also outdated but I can't write Chinese so I just updated the URLs to conform to the "supported" format. Someone will have to translate it if necessary.

I can't help with that but maybe someone will come along to fix it later :)

thatsmydoing · 2021-07-02T05:25:51Z

examples/remoteBuild.md

-A [lite version of go-getter module](https://github.com/yujunz/go-getter) is
-leveraged to get remote content, then running `kustomize build` against the
-desired directory in the local copy.
+The URL format is any valid `git clone` URL with an optional directory and some


This also precludes simple github.com/owner/repo style URLs but I think overall it's much clearer to say git clone URL instead. It's much easier for users too, since if it works with git clone then it surely works for kustomize.

The same can't be said for all the other "go-getter" style URLs. You could use the go-getter CLI to test but not everyone has that available and our format isn't even 100% compatible with it.

WDYT about adding a quick comment to this paragraph:
"Kustomize also supports github.com/owner/repo style URLs such as github.com/kubernetes-sigs/kustomize/examples/multibases/dev/?ref=v1.0.6 "
?

Those types of urls fall under the "legacy formats". I believe we should no longer officially support said URLs as they're confusing.

Points of confusion,

Bare github.com works but not for any new hosts like git.sr.ht

Does github.com mean https or ssh?

The special github handling supports using / instead of // to indicate the directory

I could be convinced to keep them but I think it just adds unnecessary complexity for both users and the code that handles urls.

natasha41575

Just a question, but overall this is a good improvement.

natasha41575 · 2021-07-16T18:06:46Z

examples/remoteBuild.md

+For example,
+`https://github.com/kubernetes-sigs/kustomize//examples/multibases/dev/?ref=v1.0.6`
+will essentially clone the git repo via HTTPS , checkout `v1.0.6` and run
+`kustomize build` inside the `examples/multibases/dev` directory.


Thanks! I like these details.

natasha41575 · 2021-07-16T18:08:24Z

examples/remoteBuild.md

-Note the kustomize root path inside archive must be appended after `//`.
-
-A base can be a URL:
+A remote kustomization directory resource can also be a URL:


Any particular reason you prefer remote kustomization directory resource over remote base? The latter feels more concise and clear to me

I thought base was deprecated, but I guess it's only the bases field but not the concept itself.

natasha41575 · 2021-07-16T18:10:19Z

examples/zh/remoteBuild.md

@@ -9,7 +9,7 @@
 <!-- @remoteOverlayBuild @test -->

 ```bash
-target="github.com/kubernetes-sigs/kustomize/examples/multibases/dev/?ref=v1.0.6"
+target="https://github.com/kubernetes-sigs/kustomize//examples/multibases/dev/?ref=v1.0.6"


I can't help with that but maybe someone will come along to fix it later :)

k8s-triage-robot · 2021-10-17T04:13:42Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

thatsmydoing · 2021-10-18T11:10:28Z

/remove-lifecycle stale

k8s-triage-robot · 2022-01-16T11:39:28Z

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

Mark this issue or PR as fresh with /remove-lifecycle stale
Mark this issue or PR as rotten with /lifecycle rotten
Close this issue or PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

thatsmydoing · 2022-01-17T09:51:27Z

/remove-lifecycle stale

KnVerey · 2022-01-18T00:42:16Z

/approve

@natasha41575 is the legacy thing a blocker for you? I'd rather not call it legacy if we have no actual intent to ever remove it, but I'd rather merge this improvement than not.

k8s-ci-robot · 2022-01-18T00:42:41Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: KnVerey, thatsmydoing

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:

~~OWNERS~~ [KnVerey]

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

natasha41575 · 2022-01-18T01:46:20Z

@KnVerey no it is not a blocker; I’m okay with this being merged as is.

natasha41575 · 2022-01-18T01:46:37Z

/lgtm

thatsmydoing · 2022-01-18T08:30:42Z

I've rebased as a test was failing. I also made some minor changes to state that only https and ssh urls are supported, and file clones are not.

KnVerey · 2022-02-04T17:39:52Z

/lgtm
/retest

thatsmydoing · 2022-02-05T05:11:59Z

/retest-required

k8s-ci-robot · 2022-02-05T05:12:12Z

@thatsmydoing: Cannot trigger testing until a trusted user reviews the PR and leaves an /ok-to-test message.

In response to this:

/retest-required

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.

thatsmydoing · 2022-02-05T05:24:16Z

I believe the test failure above is a regression from 4.4 to 4.5.

thatsmydoing · 2022-02-05T05:36:48Z

#4334 breaks handling of remote bases that start with https

thatsmydoing · 2022-02-06T08:03:24Z

I've expanded on why I think the legacy urls should be dropped in #4454

natasha41575 · 2022-02-09T22:41:12Z

/ok-to-test

natasha41575 · 2022-02-09T22:51:51Z

Starting a new release right now

natasha41575 · 2022-02-10T00:27:03Z

/retest

natasha41575 · 2022-02-10T00:43:57Z

Thank you for this PR! Very grateful that it helped to catch a regression.

k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Jul 2, 2021

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 Jul 2, 2021

k8s-ci-robot requested review from justinsb and monopole July 2, 2021 05:17

k8s-ci-robot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 2, 2021

thatsmydoing commented Jul 2, 2021

View reviewed changes

thatsmydoing mentioned this pull request Jul 12, 2021

Resources accumulation fails with remote resources using git and short git commit id as ref #3761

Closed

natasha41575 reviewed Jul 16, 2021

View reviewed changes

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 17, 2021

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Oct 18, 2021

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 16, 2022

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Jan 17, 2022

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Jan 18, 2022

k8s-ci-robot assigned natasha41575 Jan 18, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 18, 2022

Update supported URLs in remoteBuild.md

54ae9ba

thatsmydoing force-pushed the url-format branch from 1071dd2 to 54ae9ba Compare January 18, 2022 08:27

k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Jan 18, 2022

k8s-ci-robot assigned KnVerey Feb 4, 2022

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 4, 2022

natasha41575 mentioned this pull request Feb 5, 2022

Handle HTTP error codes in file loader #4334

Merged

sylr mentioned this pull request Feb 5, 2022

Fix pseudo git HTTP urls broken since 59c82659 #4453

Merged

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 Feb 9, 2022

natasha41575 mentioned this pull request Feb 9, 2022

[Question] Remote resource directory #4464

Closed

k8s-ci-robot merged commit a7f4db7 into kubernetes-sigs:master Feb 10, 2022

koba1t mentioned this pull request Jan 11, 2024

Documentation: Kubernetes kustomize documentation references Hashicorp URL format, which is outdated #5460

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update supported URLs in remoteBuild.md #4030

Update supported URLs in remoteBuild.md #4030

thatsmydoing commented Jul 2, 2021

k8s-ci-robot commented Jul 2, 2021

thatsmydoing Jul 2, 2021

natasha41575 Jul 16, 2021

thatsmydoing Jul 2, 2021

natasha41575 Jul 16, 2021 •

edited

Loading

thatsmydoing Jul 19, 2021

natasha41575 left a comment

natasha41575 Jul 16, 2021

natasha41575 Jul 16, 2021

thatsmydoing Jul 19, 2021

natasha41575 Jul 16, 2021

k8s-triage-robot commented Oct 17, 2021

thatsmydoing commented Oct 18, 2021

k8s-triage-robot commented Jan 16, 2022

thatsmydoing commented Jan 17, 2022

KnVerey commented Jan 18, 2022

k8s-ci-robot commented Jan 18, 2022

natasha41575 commented Jan 18, 2022

natasha41575 commented Jan 18, 2022

thatsmydoing commented Jan 18, 2022

KnVerey commented Feb 4, 2022

thatsmydoing commented Feb 5, 2022

k8s-ci-robot commented Feb 5, 2022

thatsmydoing commented Feb 5, 2022

thatsmydoing commented Feb 5, 2022

thatsmydoing commented Feb 6, 2022

natasha41575 commented Feb 9, 2022

natasha41575 commented Feb 9, 2022

natasha41575 commented Feb 10, 2022

natasha41575 commented Feb 10, 2022

Update supported URLs in remoteBuild.md #4030

Update supported URLs in remoteBuild.md #4030

Conversation

thatsmydoing commented Jul 2, 2021

k8s-ci-robot commented Jul 2, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natasha41575 Jul 16, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

natasha41575 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

k8s-triage-robot commented Oct 17, 2021

thatsmydoing commented Oct 18, 2021

k8s-triage-robot commented Jan 16, 2022

thatsmydoing commented Jan 17, 2022

KnVerey commented Jan 18, 2022

k8s-ci-robot commented Jan 18, 2022

natasha41575 commented Jan 18, 2022

natasha41575 commented Jan 18, 2022

thatsmydoing commented Jan 18, 2022

KnVerey commented Feb 4, 2022

thatsmydoing commented Feb 5, 2022

k8s-ci-robot commented Feb 5, 2022

thatsmydoing commented Feb 5, 2022

thatsmydoing commented Feb 5, 2022

thatsmydoing commented Feb 6, 2022

natasha41575 commented Feb 9, 2022

natasha41575 commented Feb 9, 2022

natasha41575 commented Feb 10, 2022

natasha41575 commented Feb 10, 2022

natasha41575 Jul 16, 2021 •

edited

Loading