Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
coufalja committed May 10, 2018
1 parent a018ab0 commit c5d6bbd
Show file tree
Hide file tree
Showing 11 changed files with 261 additions and 29 deletions.
7 changes: 4 additions & 3 deletions docs/git2kube.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,13 @@ Commandline tool for loading files from git repository into K8s ConfigMap
### Options

```
-h, --help help for git2kube
-h, --help help for git2kube
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube gendoc](git2kube_gendoc.md) - Generates documentation for this tool in Markdown format
* [git2kube load](git2kube_load.md) - Loads files from git repository into ConfigMap
* [git2kube watch](git2kube_watch.md) - Runs watcher that periodically check the provided repository and updates K8s configmap accordingly
* [git2kube load](git2kube_load.md) - Loads files from git repository into target
* [git2kube watch](git2kube_watch.md) - Runs watcher that periodically check the provided repository

6 changes: 6 additions & 0 deletions docs/git2kube_gendoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ git2kube gendoc [flags]
-h, --help help for gendoc
```

### Options inherited from parent commands

```
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube](git2kube.md) - Git to ConfigMap conversion tool
Expand Down
24 changes: 11 additions & 13 deletions docs/git2kube_load.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,32 @@
## git2kube load

Loads files from git repository into ConfigMap
Loads files from git repository into target

### Synopsis

Loads files from git repository into ConfigMap

```
git2kube load [flags]
```
Loads files from git repository into target

### Options

```
--annotation strings annotation to add to K8s ConfigMap (format NAME=VALUE)
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
-m, --configmap string name for the resulting ConfigMap
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
-h, --help help for load
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s ConfigMap (format NAME=VALUE)
--merge-type string how to merge ConfigMap data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
-v, --verbose verbose output
```

### Options inherited from parent commands

```
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube](git2kube.md) - Git to ConfigMap conversion tool
* [git2kube load configmap](git2kube_load_configmap.md) - Loads files from git repository into ConfigMap
* [git2kube load folder](git2kube_load_folder.md) - Loads files from git repository into Folder
* [git2kube load secret](git2kube_load_secret.md) - Loads files from git repository into Secret

39 changes: 39 additions & 0 deletions docs/git2kube_load_configmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## git2kube load configmap

Loads files from git repository into ConfigMap

### Synopsis

Loads files from git repository into ConfigMap

```
git2kube load configmap [flags]
```

### Options

```
--annotation strings annotation to add to K8s ConfigMap (format NAME=VALUE)
-m, --configmap string name for the resulting ConfigMap
-h, --help help for configmap
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s ConfigMap (format NAME=VALUE)
--merge-type string how to merge ConfigMap data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube load](git2kube_load.md) - Loads files from git repository into target

34 changes: 34 additions & 0 deletions docs/git2kube_load_folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
## git2kube load folder

Loads files from git repository into Folder

### Synopsis

Loads files from git repository into Folder

```
git2kube load folder [flags]
```

### Options

```
-h, --help help for folder
-t, --target-folder string path to target folder
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube load](git2kube_load.md) - Loads files from git repository into target

39 changes: 39 additions & 0 deletions docs/git2kube_load_secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
## git2kube load secret

Loads files from git repository into Secret

### Synopsis

Loads files from git repository into Secret

```
git2kube load secret [flags]
```

### Options

```
--annotation strings annotation to add to K8s Secret (format NAME=VALUE)
-h, --help help for secret
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s Secret (format NAME=VALUE)
--merge-type string how to merge Secret data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
-s, --secret string name for the resulting Secret
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube load](git2kube_load.md) - Loads files from git repository into target

24 changes: 11 additions & 13 deletions docs/git2kube_watch.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,33 @@
## git2kube watch

Runs watcher that periodically check the provided repository and updates K8s configmap accordingly
Runs watcher that periodically check the provided repository

### Synopsis

Runs watcher that periodically check the provided repository and updates K8s configmap accordingly

```
git2kube watch [flags]
```
Runs watcher that periodically check the provided repository

### Options

```
--annotation strings annotation to add to K8s ConfigMap (format NAME=VALUE)
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
-m, --configmap string name for the resulting ConfigMap
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
-h, --help help for watch
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-i, --interval int interval in seconds in which to try refreshing ConfigMap from git (default 10)
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s ConfigMap (format NAME=VALUE)
--merge-type string how to merge ConfigMap data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
-v, --verbose verbose output
```

### Options inherited from parent commands

```
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube](git2kube.md) - Git to ConfigMap conversion tool
* [git2kube watch configmap](git2kube_watch_configmap.md) - Runs watcher that periodically check the provided repository and updates K8s ConfigMap accordingly
* [git2kube watch folder](git2kube_watch_folder.md) - Runs watcher that periodically check the provided repository and updates target folder accordingly
* [git2kube watch secret](git2kube_watch_secret.md) - Runs watcher that periodically check the provided repository and updates K8s Secret accordingly

40 changes: 40 additions & 0 deletions docs/git2kube_watch_configmap.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## git2kube watch configmap

Runs watcher that periodically check the provided repository and updates K8s ConfigMap accordingly

### Synopsis

Runs watcher that periodically check the provided repository and updates K8s ConfigMap accordingly

```
git2kube watch configmap [flags]
```

### Options

```
--annotation strings annotation to add to K8s ConfigMap (format NAME=VALUE)
-m, --configmap string name for the resulting ConfigMap
-h, --help help for configmap
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s ConfigMap (format NAME=VALUE)
--merge-type string how to merge ConfigMap data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-i, --interval int interval in seconds in which to try refreshing ConfigMap from git (default 10)
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube watch](git2kube_watch.md) - Runs watcher that periodically check the provided repository

35 changes: 35 additions & 0 deletions docs/git2kube_watch_folder.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
## git2kube watch folder

Runs watcher that periodically check the provided repository and updates target folder accordingly

### Synopsis

Runs watcher that periodically check the provided repository and updates target folder accordingly

```
git2kube watch folder [flags]
```

### Options

```
-h, --help help for folder
-t, --target-folder string path to target folder
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-i, --interval int interval in seconds in which to try refreshing ConfigMap from git (default 10)
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube watch](git2kube_watch.md) - Runs watcher that periodically check the provided repository

40 changes: 40 additions & 0 deletions docs/git2kube_watch_secret.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
## git2kube watch secret

Runs watcher that periodically check the provided repository and updates K8s Secret accordingly

### Synopsis

Runs watcher that periodically check the provided repository and updates K8s Secret accordingly

```
git2kube watch secret [flags]
```

### Options

```
--annotation strings annotation to add to K8s Secret (format NAME=VALUE)
-h, --help help for secret
-k, --kubeconfig true if locally stored ~/.kube/config should be used, InCluster config will be used if false (options: true|false) (default: false)
--label strings label to add to K8s Secret (format NAME=VALUE)
--merge-type string how to merge Secret data whether to also delete missing values or just upsert new (options: delete|upsert) (default "delete")
-n, --namespace string target namespace for the resulting ConfigMap (default "default")
-s, --secret string name for the resulting Secret
```

### Options inherited from parent commands

```
-b, --branch string branch name to pull (default "master")
-c, --cache-folder string destination on filesystem where cache of repository will be stored (default "/tmp/git2kube/data/")
--exclude strings regex that if is a match excludes the file from the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [^\..*])
-g, --git string git repository address, either http(s) or ssh protocol has to be specified
--include strings regex that if is a match includes the file in the upload, example: '*.yaml' or 'folder/*' if you want to match a folder (default [.*])
-i, --interval int interval in seconds in which to try refreshing ConfigMap from git (default 10)
-l, --log-level string command log level (options: [panic fatal error warning info debug]) (default "info")
```

### SEE ALSO

* [git2kube watch](git2kube_watch.md) - Runs watcher that periodically check the provided repository

2 changes: 2 additions & 0 deletions pkg/cmd/common.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,10 @@ import (
"os"
)

// LoadType upload type
type LoadType int

// LoadType options enum
const (
ConfigMap LoadType = iota
Secret
Expand Down

0 comments on commit c5d6bbd

Please sign in to comment.