Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fix tables in docs. * Add cobra-generated docs and update README.md. * Fix go.mod.
- Loading branch information
Showing
22 changed files
with
305 additions
and
168 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
## gke-deploy | ||
|
||
Deploy to GKE | ||
|
||
### Synopsis | ||
|
||
Deploy to GKE in two phases, which will do the following: | ||
|
||
Prepare Phase: | ||
- Modify Kubernetes config YAMLs: | ||
- Set the digest of images that match the [--image|-i] flag, if provided. | ||
- Add app.kubernetes.io/name=[--name|-a] label, if provided. | ||
- Add app.kubernetes.io/version=[--version|-v] label, if provided. | ||
|
||
Apply Phase: | ||
- Apply Kubernetes config YAMLs to the target cluster with the provided namespace. | ||
- Wait for deployed resources to be ready before exiting. | ||
|
||
|
||
### Examples | ||
|
||
``` | ||
# Modify configs and deploy to GKE cluster. | ||
gke-deploy run -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace -c my-cluster -l us-east1-b | ||
# Deploy to GKE cluster that kubectl is currently targeting. | ||
gke-deploy run -f configs | ||
# Prepare only. | ||
gke-deploy prepare -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace | ||
# Apply only. | ||
gke-deploy apply -f configs -c my-cluster -n my-namespace -c my-cluster -l us-east1-b | ||
# Execute prepare and apply, with an intermediary step in between (e.g., manually check modified YAMLs) | ||
gke-deploy prepare -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace | ||
cat modified/* | ||
gke-deploy apply -f modified -c my-cluster -n my-namespace -c my-cluster -l us-east1-b # Pass modified directory to -f | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for gke-deploy | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gke-deploy apply](gke-deploy_apply.md) - Skip prepare phase and execute apply phase | ||
* [gke-deploy prepare](gke-deploy_prepare.md) - Execute prepare phase and skip apply phase | ||
* [gke-deploy run](gke-deploy_run.md) - Execute both prepare and apply phase | ||
|
||
###### Auto generated by spf13/cobra on 12-Jul-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
## gke-deploy apply | ||
|
||
Skip prepare phase and execute apply phase | ||
|
||
### Synopsis | ||
|
||
Apply unmodified Kubernetes resource configs. Skip prepare. | ||
|
||
- Apply Kubernetes config YAMLs to the target cluster with the provided namespace. | ||
- Wait for deployed resources to be ready before exiting. | ||
|
||
|
||
``` | ||
gke-deploy apply [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Apply only. | ||
gke-deploy apply -f configs -c my-cluster -n my-namespace -c my-cluster -l us-east1-b | ||
# Execute prepare and apply, with an intermediary step in between (e.g., manually check modified YAMLs) | ||
gke-deploy prepare -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace | ||
cat modified/* | ||
gke-deploy apply -f modified -c my-cluster -n my-namespace -c my-cluster -l us-east1-b # Pass modified directory to -f | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-c, --cluster string Name of GKE cluster to deploy to. | ||
-f, --filename string Config file or directory of config files to use to create the Kubernetes resources (file or files in directory must end with ".yml" or ".yaml"). | ||
-h, --help help for apply | ||
-l, --location string Region/zone of GKE cluster to deploy to. | ||
-n, --namespace string Name of GKE cluster to deploy to. (default "default") | ||
-p, --project string Project of GKE cluster to deploy to. If this field is not provided, the current set GCP project is used. | ||
-t, --timeout duration Timeout limit for waiting for resources to finish applying. (default 5m0s) | ||
-V, --verbose Prints underlying commands being called to stdout. | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gke-deploy](gke-deploy.md) - Deploy to GKE | ||
|
||
###### Auto generated by spf13/cobra on 12-Jul-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
## gke-deploy prepare | ||
|
||
Execute prepare phase and skip apply phase | ||
|
||
### Synopsis | ||
|
||
Prepare to deploy to GKE by generating modified Kubernetes resource configs. Skip apply. | ||
|
||
- Modify Kubernetes config YAMLs to: | ||
- Set the digest of images that match the [--image|-i] flag, if provided. | ||
- Add app.kubernetes.io/name=[--app|-a] label, if provided. | ||
- Add app.kubernetes.io/version=[--version|-v] label, if provided. | ||
|
||
|
||
``` | ||
gke-deploy prepare [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Prepare only. | ||
gke-deploy prepare -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace | ||
# Execute prepare and apply, with an intermediary step in between (e.g., manually check modified YAMLs) | ||
gke-deploy prepare -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace | ||
cat modified/* | ||
gke-deploy apply -f modified -c my-cluster -n my-namespace -c my-cluster -l us-east1-b # Pass modified directory to -f | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-a, --app string Application name of the Kubernetes deployment. | ||
-f, --filename string Config file or directory of config files to use to create the Kubernetes resources (file or files in directory must end with ".yml" or ".yaml"). | ||
-h, --help help for prepare | ||
-i, --image strings Image(s) to be deployed. Images can be set comma-delimited or as separate flags. | ||
-L, --label strings Label(s) to add to Kubernetes resources (k1=v1). Labels can be set comma-delimited or as separate flags. If two or more labels with the same key are listed, the last one is used. | ||
-n, --namespace string Name of GKE cluster to deploy to. (default "default") | ||
-o, --output string Target directory to store modified Kubernetes resource configs. (default "./output") | ||
-V, --verbose Prints underlying commands being called to stdout. | ||
-v, --version string Version of the Kubernetes deployment. | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gke-deploy](gke-deploy.md) - Deploy to GKE | ||
|
||
###### Auto generated by spf13/cobra on 12-Jul-2019 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
## gke-deploy run | ||
|
||
Execute both prepare and apply phase | ||
|
||
### Synopsis | ||
|
||
Deploy to GKE in two phases, which will do the following: | ||
|
||
Prepare Phase: | ||
- Modify Kubernetes config YAMLs: | ||
- Set the digest of images that match the [--image|-i] flag, if provided. | ||
- Add app.kubernetes.io/name=[--app|-a] label, if provided. | ||
- Add app.kubernetes.io/version=[--version|-v] label, if provided. | ||
|
||
Apply Phase: | ||
- Apply Kubernetes config YAMLs to the target cluster with the provided namespace. | ||
- Wait for deployed resources to be ready before exiting. | ||
|
||
|
||
``` | ||
gke-deploy run [flags] | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
# Modify configs and deploy to GKE cluster. | ||
gke-deploy run -f configs -i gcr.io/my-project/my-app:1.0.0 -a my-app -v 1.0.0 -o modified -n my-namespace -c my-cluster -l us-east1-b | ||
# Deploy to GKE cluster that kubectl is currently targeting. | ||
gke-deploy run -f configs | ||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-a, --app string Application name of the Kubernetes deployment. | ||
-c, --cluster string Name of GKE cluster to deploy to. | ||
-f, --filename string Config file or directory of config files to use to create the Kubernetes resources (file or files in directory must end with ".yml" or ".yaml"). | ||
-h, --help help for run | ||
-i, --image strings Image(s) to be deployed. Images can be set comma-delimited or as separate flags. | ||
-L, --label strings Label(s) to add to Kubernetes resources (k1=v1). Labels can be set comma-delimited or as separate flags. If two or more labels with the same key are listed, the last one is used. | ||
-l, --location string Region/zone of GKE cluster to deploy to. | ||
-n, --namespace string Name of GKE cluster to deploy to. (default "default") | ||
-o, --output string Target directory to store modified Kubernetes resource configs. (default "./output") | ||
-p, --project string Project of GKE cluster to deploy to. If this field is not provided, the current set GCP project is used. | ||
-t, --timeout duration Timeout limit for waiting for resources to finish applying. (default 5m0s) | ||
-V, --verbose Prints underlying commands being called to stdout. | ||
-v, --version string Version of the Kubernetes deployment. | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [gke-deploy](gke-deploy.md) - Deploy to GKE | ||
|
||
###### Auto generated by spf13/cobra on 12-Jul-2019 |
Oops, something went wrong.