Skip to content

Commit d131f38

Browse files
authored
add zarf connect list for connect service lookup (zarf-dev#615)
* add zarf connect list for connect service lookup * make logging connect description consistent * Move hidden commands to zarf internal * Update cli docs & flatten sidebar for docs automation
1 parent 299cf33 commit d131f38

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

61 files changed

+593
-425
lines changed

.github/workflows/test-k3d.yml

+1-8
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,6 @@ jobs:
1414
validate:
1515
runs-on: self-hosted
1616
steps:
17-
- name: "Ensure workspace file ownership"
18-
run: |
19-
sudo chown -R ${USER} "${GITHUB_WORKSPACE}"
20-
sudo rm -fr ~/.kube
21-
sudo rm -fr /tmp/zarf*
22-
sudo /opt/zarf/zarf-clean-k3s.sh || echo ''
23-
2417
- name: "Install GoLang"
2518
uses: actions/setup-go@v3
2619
with:
@@ -29,7 +22,7 @@ jobs:
2922
- name: "Checkout Repo"
3023
uses: actions/checkout@v3
3124

32-
- name: "Create a K3d cluster"
25+
- name: "K3d cluster init"
3326
run: k3d cluster delete && k3d cluster create
3427

3528
- name: "Build CLI"

.github/workflows/test-k3s.yml

-7
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,6 @@ jobs:
1414
validate:
1515
runs-on: self-hosted
1616
steps:
17-
- name: "Ensure workspace file ownership"
18-
run: |
19-
sudo chown -R ${USER} "${GITHUB_WORKSPACE}"
20-
sudo rm -fr /root/.kube
21-
sudo rm -fr /tmp/zarf*
22-
sudo /opt/zarf/zarf-clean-k3s.sh || echo ''
23-
2417
- name: "Install GoLang"
2518
uses: actions/setup-go@v3
2619
with:

.github/workflows/test-kind.yml

+1-8
Original file line numberDiff line numberDiff line change
@@ -14,13 +14,6 @@ jobs:
1414
validate:
1515
runs-on: self-hosted
1616
steps:
17-
- name: "Ensure workspace file ownership"
18-
run: |
19-
sudo chown -R ${USER} "${GITHUB_WORKSPACE}"
20-
sudo rm -fr ~/.kube
21-
sudo rm -fr /tmp/zarf*
22-
sudo /opt/zarf/zarf-clean-k3s.sh || echo ''
23-
2417
- name: "Install GoLang"
2518
uses: actions/setup-go@v3
2619
with:
@@ -29,7 +22,7 @@ jobs:
2922
- name: "Checkout Repo"
3023
uses: actions/checkout@v3
3124

32-
- name: "Create a KinD cluster"
25+
- name: "Kind Cluster Init"
3326
run: kind delete cluster && kind create cluster
3427

3528
- name: "Build CLI"

.hooks/verify-zarf-schema.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
#!/usr/bin/env sh
2-
go run main.go tools config-schema > zarf.schema.json
2+
go run main.go internal config-schema > zarf.schema.json
33
docker run -it -v $(pwd):/app -w /app --rm python:3.8-alpine /bin/sh -c "pip install json-schema-for-humans && generate-schema-doc --config-file .hooks/jsfh-config.json zarf.schema.json docs/4-user-guide/3-zarf-schema.md"

.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ repos:
3737
files: "src/types/types.go"
3838
types: [go]
3939
language: script
40-
description: "Runs `zarf tools config-schema > zarf.schema.json` to ensure schema is up to date"
40+
description: "Runs `zarf internal config-schema > zarf.schema.json` to ensure schema is up to date"
4141
- repo: https://github.com/python-jsonschema/check-jsonschema
4242
rev: 0.14.0
4343
hooks:

docs/13-walkthroughs/0-creating-a-zarf-package.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ When creating a Zarf package, you will need to have internet connection out so t
1313

1414

1515
## Building the init-package
16-
Creating zarf packages is a simple process that can be completed in a single command; [`zarf package create`](../4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md). This command looks for a `zarf.yaml` file in the current directory and creates a package containing all the resources the file defines. More information about what a Zarf package is can be found on the [Zarf Packages](../4-user-guide/2-zarf-packages/1-zarf-packages.md) page.
16+
Creating zarf packages is a simple process that can be completed in a single command; [`zarf package create`](../4-user-guide/1-the-zarf-cli/100-cli-commands/zarf_package_create.md). This command looks for a `zarf.yaml` file in the current directory and creates a package containing all the resources the file defines. More information about what a Zarf package is can be found on the [Zarf Packages](../4-user-guide/2-zarf-packages/1-zarf-packages.md) page.
1717

1818
```bash
1919
cd zarf # Enter the zarf repository that you have cloned down

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/0-zarf.md

-29
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/index.md

-25
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_create.md

-30
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/2-package/zarf_package_inspect.md

-27
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/index.md

-27
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/3-tools/zarf_tools_config-schema.md

-26
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/4-completion/index.md

-32
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/index.md

-25
This file was deleted.

docs/4-user-guide/1-the-zarf-cli/100-cli-commands/5-prepare/zarf_prepare_find-images.md

-27
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## zarf
2+
3+
DevSecOps Airgap Toolkit
4+
5+
```
6+
zarf [COMMAND] [flags]
7+
```
8+
9+
### Options
10+
11+
```
12+
-a, --architecture string Architecture for OCI images
13+
-h, --help help for zarf
14+
-l, --log-level string Log level when running Zarf. Valid options are: warn, info, debug, trace
15+
--no-progress Disable fancy UI progress bars, spinners, logos, etc.
16+
```
17+
18+
### SEE ALSO
19+
20+
* [zarf completion](zarf_completion.md) - Generate the autocompletion script for the specified shell
21+
* [zarf connect](zarf_connect.md) - Access services or pods deployed in the cluster.
22+
* [zarf destroy](zarf_destroy.md) - Tear it all down, we'll miss you Zarf...
23+
* [zarf init](zarf_init.md) - Prepares a k8s cluster for the deployment of Zarf packages
24+
* [zarf package](zarf_package.md) - Zarf package commands for creating, deploying, and inspecting packages
25+
* [zarf prepare](zarf_prepare.md) - Tools to help prepare assets for packaging
26+
* [zarf tools](zarf_tools.md) - Collection of additional tools to make airgap easier
27+
* [zarf version](zarf_version.md) - Displays the version of the Zarf binary
28+
29+
###### Auto generated by spf13/cobra on 17-Jul-2022

0 commit comments

Comments
 (0)