Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Noxsios committed Feb 7, 2023
1 parent 642dcf4 commit a1bff67
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -28,5 +28,6 @@ Zarf package commands for creating, deploying, and inspecting packages
* [zarf package deploy](zarf_package_deploy.md) - Use to deploy a Zarf package from a local file or URL (runs offline)
* [zarf package inspect](zarf_package_inspect.md) - Lists the payload of a Zarf package (runs offline)
* [zarf package list](zarf_package_list.md) - List out all of the packages that have been deployed to the cluster
* [zarf package publish](zarf_package_publish.md) - Publish a Zarf package to a remote registry
* [zarf package remove](zarf_package_remove.md) - Use to remove a Zarf package that has been deployed already

Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# zarf package publish
<!-- Auto-generated by docs/gen-cli-docs.sh -->

Publish a Zarf package to a remote registry

## Synopsis

Publish a Zarf package to a remote registry
Publishes a compiled package file to a remote registry. By default, the package will be published to the registry specified in the package's zarf.yaml file.

```
zarf package publish [PACKAGE] [REGISTRY] [flags]
```

## Options

```
--concurrency int Number of concurrent uploads to the registry (default 3)
-h, --help help for publish
--insecure Allow insecure connections to the registry
--password string Password for the registry
--username string Username for the registry
```

## Options inherited from parent commands

```
-a, --architecture string Architecture for OCI images
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace (default "info")
--no-log-file Disable log file creation
--no-progress Disable fancy UI progress bars, spinners, logos, etc
--tmpdir string Specify the temporary directory to use for intermediate files
--zarf-cache string Specify the location of the Zarf cache directory (default "~/.zarf-cache")
```

## SEE ALSO

* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages

4 changes: 3 additions & 1 deletion docs/4-user-guide/3-zarf-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -343,12 +343,14 @@ Must be one of:
| **Defined in** | #/definitions/ZarfComponent |

<details>
<summary><strong> <a name="components_items_name"></a>name</strong>
<summary><strong> <a name="components_items_name"></a>name *</strong>

</summary>
&nbsp;
<blockquote>

![Required](https://img.shields.io/badge/Required-red)

**Description:** The name of the component

| | |
Expand Down

0 comments on commit a1bff67

Please sign in to comment.