From 1b1d80c759193ed5cc350daebd17ea82d313e339 Mon Sep 17 00:00:00 2001 From: Jennifer Power Date: Thu, 28 Jul 2022 15:43:57 -0400 Subject: [PATCH] docs: adds build workflow to getting started guide Closes #9 Signed-off-by: Jennifer Power --- content/docs/quick-start/_index.adoc | 44 +++++++++++++++++----- docs/categories/quickstart/index.xml | 50 ++++++++++++++++++++----- docs/categories/uor/index.xml | 50 ++++++++++++++++++++----- docs/docs/_print/index.html | 50 ++++++++++++++++++++----- docs/docs/quick-start/_print/index.html | 50 ++++++++++++++++++++----- docs/docs/quick-start/index.html | 50 ++++++++++++++++++++----- docs/tags/docs/index.xml | 50 ++++++++++++++++++++----- docs/tags/edu/index.xml | 50 ++++++++++++++++++++----- 8 files changed, 322 insertions(+), 72 deletions(-) diff --git a/content/docs/quick-start/_index.adoc b/content/docs/quick-start/_index.adoc index 6ca44ba..74baa89 100644 --- a/content/docs/quick-start/_index.adoc +++ b/content/docs/quick-start/_index.adoc @@ -101,26 +101,43 @@ uor-workspace 1 directory, 3 files ---- -=== Publishing a Collection +=== Building a Collection -With the desired set of files contained within the `uor-workspace` directory, the next step is to publishing a collection. This process performs three actions: +With the desired set of files contained within the `uor-workspace` directory, the next step is to build a collection. This process performs three actions: 1. Discovers all content within the workspace 2. Produces an OCI artifact based on the content of the collection -3. Publishes the artifact to a remote repository. +3. Store the artifact in a local build cache. + +The location of the build cache can be set by exporting the environment variable `UOR_CACHE`. The default location is `~/.uor/cache`. -To publish the collection to a remote registry, let's say that an instance of `registry:2` was running on our local machine and there is the desire to publish the collection to `localhost:5000/uor-framework/getting-started:latest`. +To build and store the collection, let's say there is the desire to eventually publish the collection to `localhost:5000/uor-framework/getting-started:latest`. -Using the `push` subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary. +Using the `build` subcommand, execute the following to build and store the workspace: [source, shell] ---- -$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest +$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest +---- + +Do not be concerned about the `WARN` messages in the output of the _build_ execution. These are being emitted by the underlying link:https://oras.land[ORAS] library to client utilizes. + +=== Publishing a Collection + +To publish the collection to a remote registry, let's say that an instance of `registry:2` was running on our local machine and there is the desire to publish the stored collection to `localhost:5000/uor-framework/getting-started:latest`. + +Using the `push` subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary. + +[source, shell] +---- +$ client push localhost:5000/uor-framework/getting-started:latest + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest ---- @@ -311,18 +328,27 @@ EOF Associating a `DataSetConfiguration` to a collection is achieved when pushing a workspace to a remote registry by specifying the `--dsconfig` flag and referencing the location of the resource. -=== Publishing a Collection With Attributes +=== Building a Collection With Attributes -Publish a new tag of the collection called `dsconfig` with the additional metadata associated to the content by executing the following command: +Store a new tag of the collection called `dsconfig` with the additional metadata associated to the content by executing the following command: [source, shell] ---- -$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig +$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest +---- + +Publish the collection to the remote registry. + +[source, shell] +---- +$ client push localhost:5000/uor-framework/getting-started:dsconfig + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest ---- diff --git a/docs/categories/quickstart/index.xml b/docs/categories/quickstart/index.xml index ef56243..70546e4 100644 --- a/docs/categories/quickstart/index.xml +++ b/docs/categories/quickstart/index.xml @@ -163,9 +163,9 @@ uor-workspace </div> </div> <div class="sect2"> -<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<h3 id="_building_a_collection">Building a Collection</h3> <div class="paragraph"> -<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to publishing a collection. This process performs three actions:</p> +<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to build a collection. This process performs three actions:</p> </div> <div class="olist arabic"> <ol class="arabic"> @@ -176,24 +176,46 @@ uor-workspace <p>Produces an OCI artifact based on the content of the collection</p> </li> <li> -<p>Publishes the artifact to a remote repository.</p> +<p>Store the artifact in a local build cache.</p> </li> </ol> </div> <div class="paragraph"> -<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +<p>The location of the build cache can be set by exporting the environment variable <code>UOR_CACHE</code>. The default location is <code>~/.uor/cache</code>.</p> +</div> +<div class="paragraph"> +<p>To build and store the collection, let’s say there is the desire to eventually publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> </div> <div class="paragraph"> -<p>Using the <code>push</code> subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +<p>Using the <code>build</code> subcommand, execute the following to build and store the workspace:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Do not be concerned about the <code>WARN</code> messages in the output of the <em>build</em> execution. These are being emitted by the underlying <a href="https://oras.land">ORAS</a> library to client utilizes.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<div class="paragraph"> +<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the stored collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +</div> +<div class="paragraph"> +<p>Using the <code>push</code> subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:latest + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> @@ -427,18 +449,28 @@ EOF</code></pre> <p>Associating a <code>DataSetConfiguration</code> to a collection is achieved when pushing a workspace to a remote registry by specifying the <code>--dsconfig</code> flag and referencing the location of the resource.</p> </div> <div class="sect2"> -<h3 id="_publishing_a_collection_with_attributes">Publishing a Collection With Attributes</h3> +<h3 id="_building_a_collection_with_attributes">Building a Collection With Attributes</h3> <div class="paragraph"> -<p>Publish a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> +<p>Store a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Publish the collection to the remote registry.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:dsconfig + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> diff --git a/docs/categories/uor/index.xml b/docs/categories/uor/index.xml index f14d061..59a7419 100644 --- a/docs/categories/uor/index.xml +++ b/docs/categories/uor/index.xml @@ -163,9 +163,9 @@ uor-workspace </div> </div> <div class="sect2"> -<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<h3 id="_building_a_collection">Building a Collection</h3> <div class="paragraph"> -<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to publishing a collection. This process performs three actions:</p> +<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to build a collection. This process performs three actions:</p> </div> <div class="olist arabic"> <ol class="arabic"> @@ -176,24 +176,46 @@ uor-workspace <p>Produces an OCI artifact based on the content of the collection</p> </li> <li> -<p>Publishes the artifact to a remote repository.</p> +<p>Store the artifact in a local build cache.</p> </li> </ol> </div> <div class="paragraph"> -<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +<p>The location of the build cache can be set by exporting the environment variable <code>UOR_CACHE</code>. The default location is <code>~/.uor/cache</code>.</p> +</div> +<div class="paragraph"> +<p>To build and store the collection, let’s say there is the desire to eventually publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> </div> <div class="paragraph"> -<p>Using the <code>push</code> subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +<p>Using the <code>build</code> subcommand, execute the following to build and store the workspace:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Do not be concerned about the <code>WARN</code> messages in the output of the <em>build</em> execution. These are being emitted by the underlying <a href="https://oras.land">ORAS</a> library to client utilizes.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<div class="paragraph"> +<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the stored collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +</div> +<div class="paragraph"> +<p>Using the <code>push</code> subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:latest + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> @@ -427,18 +449,28 @@ EOF</code></pre> <p>Associating a <code>DataSetConfiguration</code> to a collection is achieved when pushing a workspace to a remote registry by specifying the <code>--dsconfig</code> flag and referencing the location of the resource.</p> </div> <div class="sect2"> -<h3 id="_publishing_a_collection_with_attributes">Publishing a Collection With Attributes</h3> +<h3 id="_building_a_collection_with_attributes">Building a Collection With Attributes</h3> <div class="paragraph"> -<p>Publish a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> +<p>Store a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Publish the collection to the remote registry.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:dsconfig + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> diff --git a/docs/docs/_print/index.html b/docs/docs/_print/index.html index c682b1e..cedd138 100644 --- a/docs/docs/_print/index.html +++ b/docs/docs/_print/index.html @@ -377,9 +377,9 @@

Assembling a Collection

-

Publishing a Collection

+

Building a Collection

-

With the desired set of files contained within the uor-workspace directory, the next step is to publishing a collection. This process performs three actions:

+

With the desired set of files contained within the uor-workspace directory, the next step is to build a collection. This process performs three actions:

    @@ -390,24 +390,46 @@

    Publishing a Collection

    Produces an OCI artifact based on the content of the collection

  1. -

    Publishes the artifact to a remote repository.

    +

    Store the artifact in a local build cache.

-

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the collection to localhost:5000/uor-framework/getting-started:latest.

+

The location of the build cache can be set by exporting the environment variable UOR_CACHE. The default location is ~/.uor/cache.

+
+
+

To build and store the collection, let’s say there is the desire to eventually publish the collection to localhost:5000/uor-framework/getting-started:latest.

-

Using the push subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+

Using the build subcommand, execute the following to build and store the workspace:

-
$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest
+
$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Do not be concerned about the WARN messages in the output of the build execution. These are being emitted by the underlying ORAS library to client utilizes.

+
+
+
+

Publishing a Collection

+
+

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the stored collection to localhost:5000/uor-framework/getting-started:latest.

+
+
+

Using the push subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:latest
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
@@ -641,18 +663,28 @@

User Defined Attributes

Associating a DataSetConfiguration to a collection is achieved when pushing a workspace to a remote registry by specifying the --dsconfig flag and referencing the location of the resource.

-

Publishing a Collection With Attributes

+

Building a Collection With Attributes

-

Publish a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

+

Store a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

-
$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
+
$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Publish the collection to the remote registry.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:dsconfig
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
diff --git a/docs/docs/quick-start/_print/index.html b/docs/docs/quick-start/_print/index.html index b499579..0fc8bba 100644 --- a/docs/docs/quick-start/_print/index.html +++ b/docs/docs/quick-start/_print/index.html @@ -288,9 +288,9 @@

Assembling a Collection

-

Publishing a Collection

+

Building a Collection

-

With the desired set of files contained within the uor-workspace directory, the next step is to publishing a collection. This process performs three actions:

+

With the desired set of files contained within the uor-workspace directory, the next step is to build a collection. This process performs three actions:

    @@ -301,24 +301,46 @@

    Publishing a Collection

    Produces an OCI artifact based on the content of the collection

  1. -

    Publishes the artifact to a remote repository.

    +

    Store the artifact in a local build cache.

-

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the collection to localhost:5000/uor-framework/getting-started:latest.

+

The location of the build cache can be set by exporting the environment variable UOR_CACHE. The default location is ~/.uor/cache.

+
+
+

To build and store the collection, let’s say there is the desire to eventually publish the collection to localhost:5000/uor-framework/getting-started:latest.

-

Using the push subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+

Using the build subcommand, execute the following to build and store the workspace:

-
$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest
+
$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Do not be concerned about the WARN messages in the output of the build execution. These are being emitted by the underlying ORAS library to client utilizes.

+
+
+
+

Publishing a Collection

+
+

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the stored collection to localhost:5000/uor-framework/getting-started:latest.

+
+
+

Using the push subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:latest
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
@@ -552,18 +574,28 @@

User Defined Attributes

Associating a DataSetConfiguration to a collection is achieved when pushing a workspace to a remote registry by specifying the --dsconfig flag and referencing the location of the resource.

-

Publishing a Collection With Attributes

+

Building a Collection With Attributes

-

Publish a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

+

Store a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

-
$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
+
$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Publish the collection to the remote registry.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:dsconfig
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
diff --git a/docs/docs/quick-start/index.html b/docs/docs/quick-start/index.html index a67e202..795c92c 100644 --- a/docs/docs/quick-start/index.html +++ b/docs/docs/quick-start/index.html @@ -408,9 +408,9 @@

Assembling a Collection

-

Publishing a Collection

+

Building a Collection

-

With the desired set of files contained within the uor-workspace directory, the next step is to publishing a collection. This process performs three actions:

+

With the desired set of files contained within the uor-workspace directory, the next step is to build a collection. This process performs three actions:

    @@ -421,24 +421,46 @@

    Publishing a Collection

    Produces an OCI artifact based on the content of the collection

  1. -

    Publishes the artifact to a remote repository.

    +

    Store the artifact in a local build cache.

-

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the collection to localhost:5000/uor-framework/getting-started:latest.

+

The location of the build cache can be set by exporting the environment variable UOR_CACHE. The default location is ~/.uor/cache.

+
+
+

To build and store the collection, let’s say there is the desire to eventually publish the collection to localhost:5000/uor-framework/getting-started:latest.

-

Using the push subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+

Using the build subcommand, execute the following to build and store the workspace:

-
$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest
+
$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Do not be concerned about the WARN messages in the output of the build execution. These are being emitted by the underlying ORAS library to client utilizes.

+
+
+
+

Publishing a Collection

+
+

To publish the collection to a remote registry, let’s say that an instance of registry:2 was running on our local machine and there is the desire to publish the stored collection to localhost:5000/uor-framework/getting-started:latest.

+
+
+

Using the push subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:latest
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
@@ -672,18 +694,28 @@

User Defined Attributes

Associating a DataSetConfiguration to a collection is achieved when pushing a workspace to a remote registry by specifying the --dsconfig flag and referencing the location of the resource.

-

Publishing a Collection With Attributes

+

Building a Collection With Attributes

-

Publish a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

+

Store a new tag of the collection called dsconfig with the additional metadata associated to the content by executing the following command:

-
$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
+
$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig
 
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: text/plain; charset=utf-8
 WARN[0000] reference for unknown type: image/jpeg
 WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json
+INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest
+
+
+
+

Publish the collection to the remote registry.

+
+
+
+
$ client push localhost:5000/uor-framework/getting-started:dsconfig
+
 INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest
diff --git a/docs/tags/docs/index.xml b/docs/tags/docs/index.xml index 65f5602..33a0833 100644 --- a/docs/tags/docs/index.xml +++ b/docs/tags/docs/index.xml @@ -163,9 +163,9 @@ uor-workspace </div> </div> <div class="sect2"> -<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<h3 id="_building_a_collection">Building a Collection</h3> <div class="paragraph"> -<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to publishing a collection. This process performs three actions:</p> +<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to build a collection. This process performs three actions:</p> </div> <div class="olist arabic"> <ol class="arabic"> @@ -176,24 +176,46 @@ uor-workspace <p>Produces an OCI artifact based on the content of the collection</p> </li> <li> -<p>Publishes the artifact to a remote repository.</p> +<p>Store the artifact in a local build cache.</p> </li> </ol> </div> <div class="paragraph"> -<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +<p>The location of the build cache can be set by exporting the environment variable <code>UOR_CACHE</code>. The default location is <code>~/.uor/cache</code>.</p> +</div> +<div class="paragraph"> +<p>To build and store the collection, let’s say there is the desire to eventually publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> </div> <div class="paragraph"> -<p>Using the <code>push</code> subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +<p>Using the <code>build</code> subcommand, execute the following to build and store the workspace:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Do not be concerned about the <code>WARN</code> messages in the output of the <em>build</em> execution. These are being emitted by the underlying <a href="https://oras.land">ORAS</a> library to client utilizes.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<div class="paragraph"> +<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the stored collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +</div> +<div class="paragraph"> +<p>Using the <code>push</code> subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:latest + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> @@ -427,18 +449,28 @@ EOF</code></pre> <p>Associating a <code>DataSetConfiguration</code> to a collection is achieved when pushing a workspace to a remote registry by specifying the <code>--dsconfig</code> flag and referencing the location of the resource.</p> </div> <div class="sect2"> -<h3 id="_publishing_a_collection_with_attributes">Publishing a Collection With Attributes</h3> +<h3 id="_building_a_collection_with_attributes">Building a Collection With Attributes</h3> <div class="paragraph"> -<p>Publish a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> +<p>Store a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Publish the collection to the remote registry.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:dsconfig + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> diff --git a/docs/tags/edu/index.xml b/docs/tags/edu/index.xml index 52e78e5..990a024 100644 --- a/docs/tags/edu/index.xml +++ b/docs/tags/edu/index.xml @@ -163,9 +163,9 @@ uor-workspace </div> </div> <div class="sect2"> -<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<h3 id="_building_a_collection">Building a Collection</h3> <div class="paragraph"> -<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to publishing a collection. This process performs three actions:</p> +<p>With the desired set of files contained within the <code>uor-workspace</code> directory, the next step is to build a collection. This process performs three actions:</p> </div> <div class="olist arabic"> <ol class="arabic"> @@ -176,24 +176,46 @@ uor-workspace <p>Produces an OCI artifact based on the content of the collection</p> </li> <li> -<p>Publishes the artifact to a remote repository.</p> +<p>Store the artifact in a local build cache.</p> </li> </ol> </div> <div class="paragraph"> -<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +<p>The location of the build cache can be set by exporting the environment variable <code>UOR_CACHE</code>. The default location is <code>~/.uor/cache</code>.</p> +</div> +<div class="paragraph"> +<p>To build and store the collection, let’s say there is the desire to eventually publish the collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> </div> <div class="paragraph"> -<p>Using the <code>push</code> subcommand, execute the following to publish the workspace to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +<p>Using the <code>build</code> subcommand, execute the following to build and store the workspace:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push uor-workspace localhost:5000/uor-framework/getting-started:latest +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build uor-workspace localhost:5000/uor-framework/getting-started:latest WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Do not be concerned about the <code>WARN</code> messages in the output of the <em>build</em> execution. These are being emitted by the underlying <a href="https://oras.land">ORAS</a> library to client utilizes.</p> +</div> +</div> +<div class="sect2"> +<h3 id="_publishing_a_collection">Publishing a Collection</h3> +<div class="paragraph"> +<p>To publish the collection to a remote registry, let’s say that an instance of <code>registry:2</code> was running on our local machine and there is the desire to publish the stored collection to <code>localhost:5000/uor-framework/getting-started:latest</code>.</p> +</div> +<div class="paragraph"> +<p>Using the <code>push</code> subcommand, execute the following to publish the stored collection to a remote registry. Additional options are also available for specifying the location of a file containing authentication details or communicating with an insecure or HTTP based registry if necessary.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:latest + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div> @@ -427,18 +449,28 @@ EOF</code></pre> <p>Associating a <code>DataSetConfiguration</code> to a collection is achieved when pushing a workspace to a remote registry by specifying the <code>--dsconfig</code> flag and referencing the location of the resource.</p> </div> <div class="sect2"> -<h3 id="_publishing_a_collection_with_attributes">Publishing a Collection With Attributes</h3> +<h3 id="_building_a_collection_with_attributes">Building a Collection With Attributes</h3> <div class="paragraph"> -<p>Publish a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> +<p>Store a new tag of the collection called <code>dsconfig</code> with the additional metadata associated to the content by executing the following command:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client build --dsconfig=dataset-configuration.yaml uor-workspace localhost:5000/uor-framework/getting-started:dsconfig WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: text/plain; charset=utf-8 WARN[0000] reference for unknown type: image/jpeg WARN[0000] reference for unknown type: application/vnd.uor.config.v1+json +INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 built with reference name localhost:5000/uor-framework/getting-started:latest</code></pre> +</div> +</div> +<div class="paragraph"> +<p>Publish the collection to the remote registry.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="highlight"><code class="language-shell" data-lang="shell">$ client push localhost:5000/uor-framework/getting-started:dsconfig + INFO[0000] Artifact sha256:43c520531d3c1f2dbebb82aaa1e55d19040075772bcdf44db32561eea73c76e9 published to localhost:5000/uor-framework/getting-started:latest</code></pre> </div> </div>