EC-785 Document the URI formats accepted by cli #1878
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1878 +/- ##
=======================================
Coverage 80.61% 80.61%
=======================================
Files 68 68
Lines 4989 4989
=======================================
Hits 4022 4022
Misses 967 967
Flags with carried forward coverage won't be shown. Click here to find out more. |
|
|
||
| A local file path scheme, such as the following, may be utilized. | ||
|
|
||
| * `file://<path>:` |
There was a problem hiding this comment.
Is the trailing : intentional here?
| * `file://<path>:` | |
| * `file://<path>` |
maybe?
There was a problem hiding this comment.
Thanks for catching this. Initially theses were headings, but in editing things, they were moved around. I'll remove the : char
| You may also use the `git::` prefix to specify a Git repository URL. The following formats are supported: | ||
|
|
||
| * `git::[email protected]:<user>/<repo>.git?ref=<reference>//<path>`: | ||
| * `git::example.com/<org>/<repo>.git?ref=<reference>//<path>`: |
There was a problem hiding this comment.
Again the : char, is an asciidoc formatting thing?
There was a problem hiding this comment.
Thanks for catching this. Initially theses were headings, but in editing things, they were moved around. I'll remove the : char
| You may also use the `http::` prefix to specify an HTTPS URL. | ||
|
|
||
| * `http::example.com/file.ext` |
There was a problem hiding this comment.
Does http really mean https here?
| You may also use the `http::` prefix to specify an HTTPS URL. | |
| * `http::example.com/file.ext` | |
| You may also use the `https::` prefix to specify an HTTPS URL. | |
| * `https::example.com/file.ext` |
There was a problem hiding this comment.
Maybe it does, just wondering.
There was a problem hiding this comment.
go-gather allows for http(s) transfers, but from ECs point of view, all http transport should be https. The prefix is http:: however.
|
|
||
| You may also use the `oci::` prefix to specify an OCI registry URL: | ||
|
|
||
| * `oci://<registry>/<repository>:<tag>` |
There was a problem hiding this comment.
For completeness, maybe include the digest formats as well, e.g.:
| * `oci://<registry>/<repository>:<tag>` | |
| * `oci://<registry>/<repository>:<tag>` | |
| * `oci::<registry>/<repository>:<tag>` | |
| * `oci://<registry>/<repository>@<digest>` | |
| * `oci::<registry>/<repository>:<tag>@<digest>` |
This commit documents the different URI formats supported by ec for the policy & data source locations. The information in this documentation addition is drawn from the underlying go-gather library. Signed-off-by: robnester-rh <[email protected]>
This commit documents the different URI formats supported by ec for the policy & data source locations. The information in this documentation addition is drawn from the underlying go-gather library.