Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

automated generation of docs from buildkite #1117

Merged
merged 2 commits into from
Jan 16, 2025
Merged

automated generation of docs from buildkite #1117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
578813b
automated generation of docs from buildkite
Jan 14, 2025
c3ec1a0
Merge branch 'main' into ngrokrock/dev-gen-changes
russorat Jan 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
68 changes: 33 additions & 35 deletions docs/agent/cli-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5638,25 +5638,24 @@ ngrok api kubernetes-operators create [flags]

### Flags

| Flag | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--binding.allowed-urls` | the regexes for urls allowed to be bound to this operator |
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--binding.name` | the name by which endpoints can be bound to this Kubernetes Operator. starts with "k8s/" |
| `--deployment.cluster-name` | user-given name for the cluster the Kubernetes Operator is deployed to |
| `--deployment.name` | the deployment name |
| `--deployment.namespace` | the namespace this Kubernetes Operator is deployed to |
| `--deployment.version` | the version of this Kubernetes Operator |
| `--description` | human-readable description of this Kubernetes Operator. optional, max 255 bytes. |
| `--enabled-features` | features enabled for this Kubernetes Operator. a subset of \{"bindings", "ingress", and "gateway"\} |
| `--metadata` | arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes. |
| `--region` | the ngrok region in which the ingress for this operator is served. defaults to "global" |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |
| Flag | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.endpoint-selectors` | the list of cel expressions that filter the k8s bound endpoints for this operator |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--deployment.cluster-name` | user-given name for the cluster the Kubernetes Operator is deployed to |
| `--deployment.name` | the deployment name |
| `--deployment.namespace` | the namespace this Kubernetes Operator is deployed to |
| `--deployment.version` | the version of this Kubernetes Operator |
| `--description` | human-readable description of this Kubernetes Operator. optional, max 255 bytes. |
| `--enabled-features` | features enabled for this Kubernetes Operator. a subset of \{"bindings", "ingress", and "gateway"\} |
| `--metadata` | arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes. |
| `--region` | the ngrok region in which the ingress for this operator is served. defaults to "global" |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |

## ngrok api kubernetes-operators delete

Expand Down Expand Up @@ -5754,22 +5753,21 @@ ngrok api kubernetes-operators update <id> [flags]

### Flags

| Flag | Description |
| ---------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--binding.allowed-urls` | the regexes for urls allowed to be bound to this operator |
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--binding.name` | the name by which endpoints can be bound to this Kubernetes Operator. starts with "k8s/" |
| `--deployment.name` | the deployment name |
| `--description` | human-readable description of this Kubernetes Operator. optional, max 255 bytes. |
| `--enabled-features` | features enabled for this Kubernetes Operator. a subset of \{"bindings", "ingress", and "gateway"\} |
| `--metadata` | arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes. |
| `--region` | the ngrok region in which the ingress for this operator is served. defaults to "global" |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |
| Flag | Description |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--binding.csr` | CSR is supplied during initial creation to enable creating a mutual TLS secured connection between ngrok and the operator. This is an internal implementation detail and subject to change. |
| `--binding.endpoint-selectors` | the list of cel expressions that filter the k8s bound endpoints for this operator |
| `--binding.ingress-endpoint` | the public ingress endpoint for this Kubernetes Operator |
| `--deployment.name` | the deployment name |
| `--description` | human-readable description of this Kubernetes Operator. optional, max 255 bytes. |
| `--enabled-features` | features enabled for this Kubernetes Operator. a subset of \{"bindings", "ingress", and "gateway"\} |
| `--metadata` | arbitrary user-defined machine-readable data of this Kubernetes Operator. optional, max 4096 bytes. |
| `--region` | the ngrok region in which the ingress for this operator is served. defaults to "global" |
| `--api-key` | API key to use |
| `--config` | path to config files; they are merged if multiple |
| `--log` | path to log file, 'stdout', 'stderr' or 'false' |
| `--log-format` | log record format: 'term', 'logfmt', 'json' |
| `--log-level` | logging level: 'debug', 'info', 'warn', 'error', 'crit' |

## ngrok api pointcfg-module

Expand Down
6 changes: 3 additions & 3 deletions docs/api/examples/_abuse_reports_create_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

```json
{
"created_at": "2024-12-19T20:27:10Z",
"created_at": "2025-01-14T10:06:42Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2qRzAJuSK8x3o2WiCIsrPzkD4wn",
"id": "abrp_2rcCuzWvsTkicfE6OIjydvsig4C",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2qRzAJuSK8x3o2WiCIsrPzkD4wn",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_abuse_reports_get_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/abuse_reports/abrp_2qRzAJuSK8x3o2WiCIsrPzkD4wn
https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C
```
6 changes: 3 additions & 3 deletions docs/api/examples/_abuse_reports_get_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@

```json
{
"created_at": "2024-12-19T20:27:10Z",
"created_at": "2025-01-14T10:06:42Z",
"hostnames": [
{
"hostname": "legit-facebook-login.ngrok.io",
"status": "PENDING"
}
],
"id": "abrp_2qRzAJuSK8x3o2WiCIsrPzkD4wn",
"id": "abrp_2rcCuzWvsTkicfE6OIjydvsig4C",
"metadata": "{\"incident_id\":1233122}",
"status": "PENDING",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2qRzAJuSK8x3o2WiCIsrPzkD4wn",
"uri": "https://api.ngrok.com/abuse_reports/abrp_2rcCuzWvsTkicfE6OIjydvsig4C",
"urls": ["http://legit-facebook-login.ngrok.io/login"]
}
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_create_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,17 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-12-19T20:27:12Z",
"created_at": "2025-01-14T10:06:43Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2qRzAWIfOohAnk3h8EGolQ8yPlr",
"id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr"
"uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl"
}
```
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_delete_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X DELETE \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr
https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl
```
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_get_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ curl \
-X GET \
-H "Authorization: Bearer {API_KEY}" \
-H "Ngrok-Version: 2" \
https://api.ngrok.com/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr
https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_get_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-12-19T20:27:12Z",
"created_at": "2025-01-14T10:06:43Z",
"description": "ACME Co. Device Ingress",
"domain": "connect.acme.com",
"id": "agin_2qRzAWIfOohAnk3h8EGolQ8yPlr",
"id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl",
"metadata": "{\"device_sku\": \"824JS4RZ1F8X\"}",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
Expand All @@ -18,6 +18,6 @@
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr"
"uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl"
}
```
6 changes: 3 additions & 3 deletions docs/api/examples/_agent_ingresses_list_response.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,18 @@
{
"certificate_management_policy": null,
"certificate_management_status": null,
"created_at": "2024-12-19T20:27:12Z",
"created_at": "2025-01-14T10:06:43Z",
"description": "acme devices",
"domain": "connect.acme.com",
"id": "agin_2qRzAWIfOohAnk3h8EGolQ8yPlr",
"id": "agin_2rcCv7Y5zd3kAkFFDZAftd060kl",
"ns_targets": [
"1.kube-dns.kube-system.svc.cluster.local.",
"2.kube-dns.kube-system.svc.cluster.local.",
"3.kube-dns.kube-system.svc.cluster.local.",
"4.kube-dns.kube-system.svc.cluster.local."
],
"region_domains": ["tunnel.us.connect.acme.com"],
"uri": "/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr"
"uri": "/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl"
}
],
"next_page_uri": null,
Expand Down
2 changes: 1 addition & 1 deletion docs/api/examples/_agent_ingresses_update_request.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ curl \
-H "Content-Type: application/json" \
-H "Ngrok-Version: 2" \
-d '{"description":"ACME Co. Device Ingress","metadata":"{\"device_sku\": \"824JS4RZ1F8X\"}"}' \
https://api.ngrok.com/agent_ingresses/agin_2qRzAWIfOohAnk3h8EGolQ8yPlr
https://api.ngrok.com/agent_ingresses/agin_2rcCv7Y5zd3kAkFFDZAftd060kl
```
Loading
Loading