87 lines
1.7 KiB
Markdown
87 lines
1.7 KiB
Markdown
|
<h1>Gateway FQDN</h1>
|
||
|
|
|
||
|
|
<h2>Table of Contents</h2>
|
||
|
|
|
||
|
|
- [Introduction](#introduction)
|
||
|
|
- [Deploy](#deploy)
|
||
|
|
- [Required Flags](#required-flags)
|
||
|
|
- [Optional Flags](#optional-flags)
|
||
|
|
- [Get](#get)
|
||
|
|
- [Cancel](#cancel)
|
||
|
|
|
||
|
|
***
|
||
|
|
|
||
|
|
## Introduction
|
||
|
|
|
||
|
|
We explain how to use gateway fully qualified domain names on the TFGrid using `tfcmd`.
|
||
|
|
|
||
|
|
## Deploy
|
||
|
|
|
||
|
|
```bash
|
||
|
|
tfcmd deploy gateway fqdn [flags]
|
||
|
|
```
|
||
|
|
|
||
|
|
### Required Flags
|
||
|
|
|
||
|
|
- name: name for the gateway deployment also used for canceling the deployment. must be unique.
|
||
|
|
- node: node id to deploy gateway on.
|
||
|
|
- backends: list of backends the gateway will forward requests to.
|
||
|
|
- fqdn: FQDN pointing to the specified node.
|
||
|
|
|
||
|
|
### Optional Flags
|
||
|
|
|
||
|
|
-tls: add TLS passthrough option (default false).
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ tfcmd deploy gateway fqdn -n gatewaytest --node 14 --backends http://93.184.216.34:80 --fqdn example.com
|
||
|
|
3:34PM INF deploying gateway fqdn
|
||
|
|
3:34PM INF gateway fqdn deployed
|
||
|
|
```
|
||
|
|
|
||
|
|
## Get
|
||
|
|
|
||
|
|
```bash
|
||
|
|
tfcmd get gateway fqdn <gateway>
|
||
|
|
```
|
||
|
|
|
||
|
|
gateway is the name used when deploying gateway-fqdn using tfcmd.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ tfcmd get gateway fqdn gatewaytest
|
||
|
|
2:05PM INF gateway fqdn:
|
||
|
|
{
|
||
|
|
"NodeID": 14,
|
||
|
|
"Backends": [
|
||
|
|
"http://93.184.216.34:80"
|
||
|
|
],
|
||
|
|
"FQDN": "awady.gridtesting.xyz",
|
||
|
|
"Name": "gatewaytest",
|
||
|
|
"TLSPassthrough": false,
|
||
|
|
"Description": "",
|
||
|
|
"NodeDeploymentID": {
|
||
|
|
"14": 19653
|
||
|
|
},
|
||
|
|
"SolutionType": "gatewaytest",
|
||
|
|
"ContractID": 19653
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Cancel
|
||
|
|
|
||
|
|
```bash
|
||
|
|
tfcmd cancel <deployment-name>
|
||
|
|
```
|
||
|
|
|
||
|
|
deployment-name is the name of the deployment specified in while deploying using tfcmd.
|
||
|
|
|
||
|
|
Example:
|
||
|
|
|
||
|
|
```console
|
||
|
|
$ tfcmd cancel gatewaytest
|
||
|
|
3:37PM INF canceling contracts for project gatewaytest
|
||
|
|
3:37PM INF gatewaytest canceled
|
||
|
|
```
|