mirror of https://github.com/dotnet/tye.git
Browse Source
Adds docs for - tye init - tye run - tye deploy Somewhat follows the style of docs for dotnet commands.pull/116/head
committed by
GitHub
6 changed files with 241 additions and 3 deletions
@ -0,0 +1,66 @@ |
|||
# tye deploy |
|||
|
|||
## Name |
|||
|
|||
`tye deploy` - Deploys the application to Kubernetes. |
|||
|
|||
## Synopsis |
|||
|
|||
```text |
|||
tye deploy [-?|-h|--help] [-i|--interactive] [-v|--verbosity <Debug|Info|Quiet>] [-f|--force] [<PATH>] |
|||
``` |
|||
|
|||
## Description |
|||
|
|||
The `tye deploy` command will deploy an application to Kubernetes. `tye deploy` by default will: |
|||
|
|||
- Create a docker image for each project in your application. |
|||
- Push each docker image to your container registry. |
|||
- Generate a Kubernetes Deployment and Service for each project. |
|||
- Apply the generated Deployment and Service to your current Kubernetes context. |
|||
|
|||
## Arguments |
|||
|
|||
`PATH` |
|||
|
|||
The path to either a file or directory to execute `tye deploy` on. Can either be a yaml, sln, or project file, however it is recommend to have a tye.yaml file for `tye deploy`. |
|||
|
|||
If a directory path is specified, `tye deploy` will default to using these files, in the following order: |
|||
|
|||
- `tye.yaml` |
|||
- `*.sln` |
|||
- `*.csproj/*.fsproj` |
|||
|
|||
## Options |
|||
|
|||
- `-i|--interactive` |
|||
|
|||
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. |
|||
|
|||
- `-f|--force` |
|||
|
|||
Override validation and forces deployment. |
|||
|
|||
## Examples |
|||
|
|||
- Deploy an application from the current directory: |
|||
|
|||
```text |
|||
tye deploy |
|||
``` |
|||
|
|||
- Deploy an application with interactive input: |
|||
|
|||
```text |
|||
tye run --interactive |
|||
``` |
|||
|
|||
- Deploy an application, increasing log verbosity to Debug. |
|||
|
|||
```text |
|||
tye deploy --verbosity Debug |
|||
``` |
|||
@ -0,0 +1,66 @@ |
|||
# tye init |
|||
|
|||
## Name |
|||
|
|||
`tye init` - Scaffolds a tye.yaml file representing the application. |
|||
|
|||
## Synopsis |
|||
|
|||
```text |
|||
tye init [-?|-h|--help] [-f|--force] [<PATH>] |
|||
``` |
|||
|
|||
## Description |
|||
|
|||
The `tye init` command scaffolds a `tye.yaml` file to allow customizing different aspects of `tye run` and `tye deploy`. |
|||
|
|||
`tye init` will by default scaffold each project(s) in an application. For example, if there was a solution file (sln) that contained two csproj files, the `tye.yaml` contents would look like: |
|||
|
|||
```yaml |
|||
name: application |
|||
services: |
|||
- name: project1 |
|||
project: project1.csproj |
|||
- name: project2 |
|||
project: project2/project2.csproj |
|||
``` |
|||
|
|||
See [the tye.yaml schema](../schema.md) to learn more about customizations that can be made to the `tye.yaml` file. |
|||
|
|||
## Arguments |
|||
|
|||
`PATH` |
|||
|
|||
The path to either a file or directory to run `tye init` on. Can either be a yaml, sln, or project file. |
|||
|
|||
## Options |
|||
|
|||
- `-f|--force` |
|||
|
|||
If a `tye.yaml` file is already present, overwrites it with a newly scaffolded `tye.yaml`. |
|||
|
|||
## Examples |
|||
|
|||
- Scaffold a `tye.yaml` in the current directory: |
|||
|
|||
```text |
|||
tye init |
|||
``` |
|||
|
|||
- Scaffold a `tye.yaml` from a path to a directory: |
|||
|
|||
```text |
|||
tye init PATH_TO_DIRECTORY |
|||
``` |
|||
|
|||
- Scaffold a `tye.yaml` from a project file (*.csproj, *.fsproj): |
|||
|
|||
```text |
|||
tye init project.csproj |
|||
``` |
|||
|
|||
- Scaffold a `tye.yaml` from a solution file (sln): |
|||
|
|||
```text |
|||
tye init app.sln |
|||
``` |
|||
@ -0,0 +1,72 @@ |
|||
# tye run |
|||
|
|||
## Name |
|||
|
|||
`tye run` - Runs the application. |
|||
|
|||
## Synopsis |
|||
|
|||
```text |
|||
tye run [-?|-h|--help] [--no-build] [--port <port>] [--dtrace] [--debug][-f|--force] [<PATH>] |
|||
``` |
|||
|
|||
## Description |
|||
|
|||
The `tye run` command will run an application locally. `tye run` by default will: |
|||
|
|||
- Start all services/projects in the application. |
|||
- Start a dashboard at <http://localhost:8000> to view all services running in the application. |
|||
|
|||
## Arguments |
|||
|
|||
`PATH` |
|||
|
|||
The path to either a file or directory to run `tye run` on. Can either be a yaml, sln, or project file. |
|||
|
|||
If a directory path is specified, `tye run` will default to using these files, in the following order: |
|||
|
|||
- `tye.yaml` |
|||
- `*.sln` |
|||
- `*.csproj/*.fsproj` |
|||
|
|||
## Options |
|||
|
|||
- `--no-build` |
|||
|
|||
Does not build projects before running. |
|||
|
|||
- `--port <port>` |
|||
|
|||
The port to run the dashboard on. Defaults to port 8000 if not specified. |
|||
|
|||
- `--logs` |
|||
|
|||
Write structured application logs to the specified log providers. Supported providers are console, elastic (Elasticsearch), ai (ApplicationInsights), seq. |
|||
|
|||
- `--dtrace <logs>` |
|||
|
|||
Write distributed traces to the specified providers. Supported providers are zipkin. |
|||
|
|||
- `--debug` |
|||
|
|||
Waits for debugger attach in all services. |
|||
|
|||
## Examples |
|||
|
|||
- Run an application in the current directory: |
|||
|
|||
```text |
|||
tye run |
|||
``` |
|||
|
|||
- Run an application where the dashboard is hosted on another port: |
|||
|
|||
```text |
|||
tye run --port 5050 |
|||
``` |
|||
|
|||
- Run an application and wait for all projects to debug attach: |
|||
|
|||
```text |
|||
tye run --debug |
|||
``` |
|||
@ -0,0 +1,34 @@ |
|||
# tye command |
|||
|
|||
## Name |
|||
|
|||
`tye` - The base tye command. |
|||
|
|||
## Synopsis |
|||
|
|||
To get more information about the available commands: |
|||
|
|||
```text |
|||
|
|||
tye [-?|-h|--help] [--version] |
|||
``` |
|||
|
|||
## Description |
|||
|
|||
The `tye` command provides commands for working with a multi-project application. |
|||
|
|||
For example, [`tye run`](tye-run.md) runs an application. Each command defines its own options and arguments. All commands support the `--help` option for printing out brief documentation about how to use the command. |
|||
|
|||
## Options |
|||
|
|||
- **`--version`** |
|||
|
|||
Prints out the version of tye in use. |
|||
|
|||
## tye commands |
|||
|
|||
| Command | Function | |
|||
| --------------------------------------------- | ------------------------------------------------------------------- | |
|||
| [tye init](tye-init.md) | Scaffolds a tye.yaml file representing the application. | |
|||
| [tye run](tye-run.md) | Runs an application. | |
|||
| [tye deploy](tye-deploy.md) | Deploys an application. | |
|||
Loading…
Reference in new issue