Browse Source

Update cli args documentation (#760)

pull/763/head
John Luo 6 years ago
committed by GitHub
parent
commit
90d3e4e480
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 18
      docs/reference/commandline/tye-build.md
  2. 22
      docs/reference/commandline/tye-deploy.md
  3. 4
      docs/reference/commandline/tye-init.md
  4. 18
      docs/reference/commandline/tye-push.md
  5. 38
      docs/reference/commandline/tye-run.md
  6. 16
      docs/reference/commandline/tye-undeploy.md

18
docs/reference/commandline/tye-build.md

@ -4,15 +4,15 @@
`tye build` - Builds the application's containers. `tye build` - Builds the application's containers.
## Synopsis ## Synopsis
```text ```text
tye build [-?|-h|--help] [-v|--verbosity <Debug|Info|Quiet>] [<PATH>] tye build [-?|-h|--help] [-i|--interactive] [--tags <tags>] [-v|--verbosity <Debug|Info|Quiet>] [-f|--framework <framework>] [<PATH>]
``` ```
## Description ## Description
The `tye build` command will build all of an application's project services into containers without deploying or pushing the containers remotely. The `tye build` command will build all of an application's project services into containers without deploying or pushing the containers remotely.
This command is useful for testing that all projects successfully build. This command is useful for testing that all projects successfully build.
@ -30,10 +30,22 @@ If a directory path is specified, `tye build` will default to using these files,
## Options ## Options
- `-i|--interactive`
Interactive mode.
- `--tags <tags>`
Filter the group of running services by tag.
- `-v|--verbosity <Debug|Info|Quiet>` - `-v|--verbosity <Debug|Info|Quiet>`
The verbosity of logs emitted by `tye build`. Defaults to Info. The verbosity of logs emitted by `tye build`. Defaults to Info.
- `-f|--framework <framework>`
The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint.
## Examples ## Examples

22
docs/reference/commandline/tye-deploy.md

@ -4,10 +4,10 @@
`tye deploy` - Deploys the application to Kubernetes. `tye deploy` - Deploys the application to Kubernetes.
## Synopsis ## Synopsis
```text ```text
tye deploy [-?|-h|--help] [-i|--interactive] [-n|--namespace <n>] [-v|--verbosity <Debug|Info|Quiet>] [-f|--force] [<PATH>] tye deploy [-?|-h|--help] [-i|--interactive] [-v|--verbosity <Debug|Info|Quiet>] [-n|--namespace <n>] [-f|--framework <framework>] [--tags <tags>] [--force] [<PATH>]
``` ```
## Description ## Description
@ -27,7 +27,7 @@ The `tye deploy` command will deploy an application to Kubernetes. `tye deploy`
> :bulb: Use `kubectl config view --minify --output 'jsonpath={..namespace}'` to view the current namespace. > :bulb: Use `kubectl config view --minify --output 'jsonpath={..namespace}'` to view the current namespace.
> :warning: The `tye deploy` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. > :warning: The `tye deploy` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line.
> :bulb: The `tye deploy` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye deploy`. > :bulb: The `tye deploy` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye deploy`.
@ -51,15 +51,23 @@ If a directory path is specified, `tye deploy` will default to using these files
Does an interactive deployment that will accept input for values that are required by default. Does an interactive deployment that will accept input for values that are required by default.
- `-v|--verbosity <Debug|Info|Quiet>`
The verbosity of logs emitted by `tye deploy`. Defaults to Info.
- `-n|--namespace` - `-n|--namespace`
Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`. Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`.
- `-v|--verbosity <Debug|Info|Quiet>` - `-f|--framework <framework>`
The verbosity of logs emitted by `tye deploy`. Defaults to Info. The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint.
- `--tags <tags>`
Filter the group of running services by tag.
- `-f|--force` - `--force`
Override validation and forces deployment. Override validation and forces deployment.

4
docs/reference/commandline/tye-init.md

@ -7,7 +7,7 @@
## Synopsis ## Synopsis
```text ```text
tye init [-?|-h|--help] [-f|--force] [<PATH>] tye init [-?|-h|--help] [--force] [<PATH>]
``` ```
## Description ## Description
@ -35,7 +35,7 @@ The path to either a file or directory to run `tye init` on. Can either be a yam
## Options ## Options
- `-f|--force` - `--force`
If a `tye.yaml` file is already present, overwrites it with a newly scaffolded `tye.yaml`. If a `tye.yaml` file is already present, overwrites it with a newly scaffolded `tye.yaml`.

18
docs/reference/commandline/tye-push.md

@ -4,10 +4,10 @@
`tye push` - Builds the application's containers and pushes them to the container registry. `tye push` - Builds the application's containers and pushes them to the container registry.
## Synopsis ## Synopsis
```text ```text
tye push [-?|-h|--help] [-i|--interactive] [-v|--verbosity <Debug|Info|Quiet>] [<PATH>] tye push [-?|-h|--help] [-i|--interactive] [-v|--verbosity <Debug|Info|Quiet>] [--tags <tags>] [-f|--framework <framework>] [--force] [<PATH>]
``` ```
## Description ## Description
@ -16,7 +16,7 @@ The `tye push` command will build all of an application's project services into
This command is useful if you want to use Tye to containerize .NET projects and manage deployment separately. This command is useful if you want to use Tye to containerize .NET projects and manage deployment separately.
> :warning: The `tye push` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line. > :warning: The `tye push` command requires access to a remote container registry. Images will be tagged using the registry configured in `tye.yaml` (if present), or using a registry supplied interactively at the command line.
> :bulb: The `tye push` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye push`. > :bulb: The `tye push` command uses Docker's credentials for pushing to the remote container registry. Make sure Docker is configured to push to your registry before running `tye push`.
@ -42,6 +42,18 @@ If a directory path is specified, `tye push` will default to using these files,
The verbosity of logs emitted by `tye deploy`. Defaults to Info. The verbosity of logs emitted by `tye deploy`. Defaults to Info.
- `--tags <tags>`
Filter the group of running services by tag.
- `-f|--framework <framework>`
The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint.
- `--force`
Override validation and force push.
## Examples ## Examples
- Push an application from the current directory: - Push an application from the current directory:

38
docs/reference/commandline/tye-run.md

@ -4,10 +4,10 @@
`tye run` - Runs the application. `tye run` - Runs the application.
## Synopsis ## Synopsis
```text ```text
tye run [-?|-h|--help] [--no-build] [--port <port>] [--dtrace] [--debug] [-f|--force] [-v|--verbosity <verbosity>] [<PATH>] tye run [-?|-h|--help] [--no-build] [--port <port>] [--logs <logs>] [--dtrace <trace>] [--metrics <metrics>] [--debug <service>] [--docker] [--dashboard] [--watch] [-f|--framework <framework>] [--tags <tags>] [-v|--verbosity <Debug|Info|Quiet>] [<PATH>]
``` ```
## Description ## Description
@ -39,11 +39,11 @@ If a directory path is specified, `tye run` will default to using these files, i
The port to run the dashboard on. Defaults to port 8000 if not specified. The port to run the dashboard on. Defaults to port 8000 if not specified.
- `--logs` - `--logs <logs>`
Write structured application logs to the specified log providers. Supported providers are console, elastic (Elasticsearch), ai (ApplicationInsights), seq. Write structured application logs to the specified log providers. Supported providers are console, elastic (Elasticsearch), ai (ApplicationInsights), seq.
- `--dtrace <logs>` - `--dtrace <trace>`
Write distributed traces to the specified providers. Supported providers are zipkin. Write distributed traces to the specified providers. Supported providers are zipkin.
@ -51,21 +51,37 @@ If a directory path is specified, `tye run` will default to using these files, i
Waits for debugger attach to service. Specify `*` to wait to attach to all services. Waits for debugger attach to service. Specify `*` to wait to attach to all services.
- `--docker`
Run projects as docker containers.
- `--dashboard`
Launch dashboard on run.
- `--watch`
Watches for file changes in all projects that are built by tye. Uses [`dotnet watch`](https://docs.microsoft.com/en-us/aspnet/core/tutorials/dotnet-watch?view=aspnetcore-3.1) to monitor for file changes.
- `-f|--framework <framework>`
The target framework hint to use for all cross-targeting projects with multiple TFMs. This value must be a valid target framework for each individual cross-targeting project. Non-crosstargeting projects will ignore this hint and the value TFM configured in tye.yaml will override this hint.
- `--tags <tags>`
Filter the group of running services by tag.
- `--verbosity <verbosity>` - `--verbosity <verbosity>`
Sets the output verbosity of the process. Sets the output verbosity of the process.
Possible values are Possible values are
* `debug` - display all logs that the process outputs * `debug` - display all logs that the process outputs
* `info` - display only informational logs * `info` - display only informational logs
* `quiet` - display only warnings and errors * `quiet` - display only warnings and errors
The default value is `info` The default value is `info`
- `--watch`
Watches for file changes in all projects that are built by tye. Uses [`dotnet watch`](https://docs.microsoft.com/en-us/aspnet/core/tutorials/dotnet-watch?view=aspnetcore-3.1) to monitor for file changes.
## Examples ## Examples
- Run an application in the current directory: - Run an application in the current directory:

16
docs/reference/commandline/tye-undeploy.md

@ -4,10 +4,10 @@
`tye undeploy` - Removes a deployed application from Kubernetes. `tye undeploy` - Removes a deployed application from Kubernetes.
## Synopsis ## Synopsis
```text ```text
tye undeploy [-?|-h|--help] [-i|--interactive] [-n|--namespace <n>] [-v|--verbosity <Debug|Info|Quiet>] [--what-if] [<PATH>] tye undeploy [-?|-h|--help] [-n|--namespace <n>] [-i|--interactive] [-v|--verbosity <Debug|Info|Quiet>] [--tags <tags>] [--what-if] [<PATH>]
``` ```
## Description ## Description
@ -45,18 +45,22 @@ If a directory path is specified, `tye undeploy` will default to using these fil
## Options ## Options
- `-n|--namespace`
Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`.
- `-i|--interactive` - `-i|--interactive`
Does an interactive undeploy that will prompt for deletion of each resource. Does an interactive undeploy that will prompt for deletion of each resource.
- `-n|--namespace`
Specifies the Kubernetes namespace for deployment. Overrides a namespace value set in `tye.yaml`.
- `-v|--verbosity <Debug|Info|Quiet>` - `-v|--verbosity <Debug|Info|Quiet>`
The verbosity of logs emitted by `tye undeploy`. Defaults to Info. The verbosity of logs emitted by `tye undeploy`. Defaults to Info.
- `--tags <tags>`
Filter the group of running services by tag.
- `--what-if` - `--what-if`
Print each resource instead of deleting. Print each resource instead of deleting.

Loading…
Cancel
Save