Skip to content

Commit

Permalink
Add air-gap install, sync CLI docs, fix images with transparent backg…
Browse files Browse the repository at this point in the history
…round (#61)

* Fix images with transparent background - they didn't look good in dark mode
  • Loading branch information
mszostok authored Sep 17, 2021
1 parent b92235c commit f02d74c
Show file tree
Hide file tree
Showing 54 changed files with 504 additions and 65 deletions.
2 changes: 1 addition & 1 deletion docs/architecture/assets/runner-arch.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 3 additions & 2 deletions docs/cli/commands/capact.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,8 +51,9 @@ capact [flags]
### Options

```
-c, --config string Path to the YAML config file
-h, --help help for capact
-c, --config string Path to the YAML config file
-h, --help help for capact
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ This command consists of multiple subcommands to interact with target Actions
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,8 @@ capact action create INTERFACE [flags]
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action_delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ capact action delete --name-regex='upgrade-*' --namespace=foo
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action_get.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ capact action get funny-stallman -ojson
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action_run.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@ capact action run ACTION [flags]
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_action_watch.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ capact action watch @latest
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
4 changes: 3 additions & 1 deletion docs/cli/commands/capact_alpha.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,13 @@ Subcommand for alpha features in the CLI
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact](capact.md) - Collective Capability Manager CLI
* [capact alpha archive-images](capact_alpha_archive-images.md) - Export Capact Docker images to a tar archive
* [capact alpha manifest-gen](capact_alpha_manifest-gen.md) - Manifests generation

30 changes: 30 additions & 0 deletions docs/cli/commands/capact_alpha_archive-images.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: capact alpha archive-images
---

## capact alpha archive-images

Export Capact Docker images to a tar archive

### Synopsis

Subcommand for various manifest generation operations

### Options

```
-h, --help help for archive-images
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact alpha](capact_alpha.md) - Alpha features
* [capact alpha archive-images helm](capact_alpha_archive-images_helm.md) - Archive all the Docker container images used in Capact Helm charts

52 changes: 52 additions & 0 deletions docs/cli/commands/capact_alpha_archive-images_helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
---
title: capact alpha archive-images helm
---

## capact alpha archive-images helm

Archive all the Docker container images used in Capact Helm charts

```
capact alpha archive-images helm [flags]
```

### Examples

```
# Archive images from the stable Capact Helm repository from version 0.5.0
capact alpha archive-images helm --version 0.5.0 --output ./capact-images-0.5.0.tar
# Archive images from the Helm Chart released from the '0fbf562' commit on the main branch
capact alpha archive-images helm --version 0.4.0-0fbf562 --helm-repo @latest --output-stdout > ./capact-images-0.4.0-0fbf562.tar
# You can use gzip to compress the output and make the backup smaller.
capact alpha archive-images helm --version 0.5.0 --output ./capact-images-0.5.0.tar.gz --compress gzip
# You can pipe output to use custom gzip
capact alpha archive-images helm --version 0.5.0 --output-stdout | gzip > myimage_latest.tar.gz
```

### Options

```
--compress string Use a given compress algorithm. Allowed values: gzip
--helm-repo string Capact Helm chart repository location. It can be relative path to current working directory or URL. Use @latest tag to select repository which holds the latest Helm chart versions. (default "https://storage.googleapis.com/capactio-stable-charts")
-h, --help help for helm
-o, --output string Write output to a file, instead of standard output.
--output-stdout Write output to a standard output, instead of file.
--save-component strings Components names for which Docker images should be saved. Takes comma-separated list. (default [neo4j,ingress-nginx,argo,cert-manager,kubed,monitoring,capact])
--version string Capact version. Possible values @latest, @local, 0.3.0, ... (default "@latest")
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact alpha archive-images](capact_alpha_archive-images.md) - Export Capact Docker images to a tar archive

5 changes: 3 additions & 2 deletions docs/cli/commands/capact_alpha_manifest-gen.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,14 @@ Subcommand for various manifest generation operations
```
-h, --help help for manifest-gen
-o, --output string Path to the output directory for the generated manifests (default "generated")
--override Override existing manifest files
--overwrite Overwrite existing manifest files
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
8 changes: 5 additions & 3 deletions docs/cli/commands/capact_alpha_manifest-gen_implementation.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,15 @@ Generate new Implementation manifests for various tools.
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--override Override existing manifest files
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--overwrite Overwrite existing manifest files
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact alpha manifest-gen](capact_alpha_manifest-gen.md) - Manifests generation
* [capact alpha manifest-gen implementation helm](capact_alpha_manifest-gen_implementation_helm.md) - Generate Helm chart based manifests
* [capact alpha manifest-gen implementation terraform](capact_alpha_manifest-gen_implementation_terraform.md) - Generate Terraform based manifests

39 changes: 39 additions & 0 deletions docs/cli/commands/capact_alpha_manifest-gen_implementation_helm.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
title: capact alpha manifest-gen implementation helm
---

## capact alpha manifest-gen implementation helm

Generate Helm chart based manifests

### Synopsis

Generate Implementation manifests based on a Helm chart

```
capact alpha manifest-gen implementation helm [MANIFEST_PATH] [HELM_CHART_NAME] [flags]
```

### Options

```
-h, --help help for helm
-i, --interface string Path with revision of the Interface, which is implemented by this Implementation
--repo string URL of the Helm repository
-r, --revision string Revision of the Implementation manifest (default "0.1.0")
--version string Version of the Helm chart
```

### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--overwrite Overwrite existing manifest files
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact alpha manifest-gen implementation](capact_alpha_manifest-gen_implementation.md) - Generate new Implementation manifests

Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Generate Terraform based manifests

### Synopsis

Generate Terraform based manifests based on a Terraform module
Generate Implementation manifests based on a Terraform module

```
capact alpha manifest-gen implementation terraform [MANIFEST_PATH] [TERRAFORM_MODULE_PATH] [flags]
Expand Down Expand Up @@ -40,9 +40,10 @@ capact alpha manifest-gen implementation terraform cap.implementation.gcp.clouds
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--override Override existing manifest files
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--overwrite Overwrite existing manifest files
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
7 changes: 4 additions & 3 deletions docs/cli/commands/capact_alpha_manifest-gen_interface.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,10 @@ capact alpha content interface cap.interface.database.postgresql install
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--override Override existing manifest files
-c, --config string Path to the YAML config file
-o, --output string Path to the output directory for the generated manifests (default "generated")
--overwrite Overwrite existing manifest files
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ capact completion [bash|zsh|fish|powershell] [flags]
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_config.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,8 @@ Display or change configuration settings for the Hub
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_config_get-contexts.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ capact config get-contexts
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_config_set-context.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,8 @@ capact config set-context localhost:8080
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
3 changes: 2 additions & 1 deletion docs/cli/commands/capact_environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@ This command consists of multiple subcommands to interact with a Capact environm
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO
Expand Down
4 changes: 3 additions & 1 deletion docs/cli/commands/capact_environment_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,13 @@ This command consists of multiple subcommands to create a Capact environment
### Options inherited from parent commands

```
-c, --config string Path to the YAML config file
-c, --config string Path to the YAML config file
-v, --verbose int/string[=simple] Prints more verbose output. Allowed values: 0 - disable, 1 - simple, 2 - trace (default 0 - disable)
```

### SEE ALSO

* [capact environment](capact_environment.md) - This command consists of multiple subcommands to interact with a Capact environments
* [capact environment create k3d](capact_environment_create_k3d.md) - Provision local k3d cluster
* [capact environment create kind](capact_environment_create_kind.md) - Provision local kind cluster

Loading

0 comments on commit f02d74c

Please sign in to comment.