Skip to content
This repository has been archived by the owner on Dec 7, 2023. It is now read-only.

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
darkowlzz committed Aug 23, 2020
1 parent 77fb433 commit 3223c11
Show file tree
Hide file tree
Showing 37 changed files with 120 additions and 186 deletions.
10 changes: 4 additions & 6 deletions docs/cli/ignite/ignite.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,10 @@ Example usage:
### Options

```
-h, --help help for ignite
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
-h, --help help for ignite
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_attach.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ ignite attach <vm> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_completion.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,9 @@ ignite completion [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_cp.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,9 @@ ignite cp <source> <dest> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
10 changes: 5 additions & 5 deletions docs/cli/ignite/ignite_create.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,10 @@ ignite create <OCI image> [flags]
-l, --label stringArray Set a label (foo=bar)
--memory size Amount of RAM to allocate for the VM (default 512.0 MB)
-n, --name string Specify the name
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-p, --ports strings Map host ports to VM ports
--require-name Require VM name to be passed, no name generation
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--sandbox-image oci-image Specify an OCI image for the VM sandbox (default weaveworks/ignite:dev)
-s, --size size VM filesystem size, for example 5GB or 2048MB (default 4.0 GB)
--ssh[=<path>] Enable SSH for the VM. If <path> is given, it will be imported as the public key. If just '--ssh' is specified, a new keypair will be generated. (default is unset, which disables SSH access to the VM)
Expand All @@ -54,11 +56,9 @@ ignite create <OCI image> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_exec.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,9 @@ ignite exec <vm> <command...> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_image.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ ignite image [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_image_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ ignite image import <OCI image> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_image_ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ ignite image ls [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_image_rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@ ignite image rm <image>... [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_inspect.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,9 @@ ignite inspect <kind> <object> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_kernel.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ ignite kernel [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_kernel_import.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ ignite kernel import <OCI image> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_kernel_ls.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,9 @@ ignite kernel ls [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_kernel_rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,9 @@ ignite kernel rm <kernel>... [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_kill.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,9 @@ ignite kill <vm>... [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,9 @@ ignite logs <vm> [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_ps.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,9 @@ ignite ps [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
8 changes: 3 additions & 5 deletions docs/cli/ignite/ignite_rm.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,9 @@ ignite rm <vm>... [flags]
### Options inherited from parent commands

```
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
--network-plugin plugin Network plugin to use. Available options are: [cni docker-bridge] (default cni)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
--runtime runtime Container runtime to use. Available options are: [docker containerd] (default containerd)
--ignite-config string Ignite configuration path; refer to the 'Ignite Configuration' docs for more details
--log-level loglevel Specify the loglevel for the program (default info)
-q, --quiet The quiet mode allows for machine-parsable output by printing only IDs
```

### SEE ALSO
Expand Down
Loading

0 comments on commit 3223c11

Please sign in to comment.