Skip to content

Commit 85a14a5

Browse files
committed
Improved wrangler configuration
1 parent f257f1e commit 85a14a5

File tree

4 files changed

+123
-109
lines changed

4 files changed

+123
-109
lines changed

src/content/docs/pipelines/observability/metrics.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ sidebar:
66

77
---
88

9-
Pipelines expose metrics which allow you to measure data ingested, requests made, and data delivered, across all your Pipelines.
9+
Pipelines expose metrics which allow you to measure data ingested, requests made, and data delivered.
1010

1111
The metrics displayed in the [Cloudflare dashboard](https://dash.cloudflare.com/) are queried from Cloudflare’s [GraphQL Analytics API](/analytics/graphql-api/). You can access the metrics [programmatically](#query-via-the-graphql-api) via GraphQL or HTTP client.
1212

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
11
---
2-
pcx_content_type: navigation
2+
pcx_content_type: concept
33
title: Wrangler commands
4-
external_link: /workers/wrangler/commands/#pipelines
54
sidebar:
65
order: 80
76

8-
---
7+
---
8+
9+
import { Render, Type, MetaInfo } from "~/components"
10+
11+
<Render file="wrangler-commands/pipelines" product="workers" />
12+
13+
## Global commands
14+
<Render file="wrangler-commands/global-flags" product="workers" />

src/content/docs/workers/wrangler/commands.mdx

Lines changed: 2 additions & 105 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ Wrangler offers a number of commands to manage your Cloudflare Workers.
3636
- [`workflows`](#workflows) - Manage and configure Workflows.
3737
- [`tail`](#tail) - Start a session to livestream logs from a deployed Worker.
3838
- [`pages`](#pages) - Configure Cloudflare Pages.
39+
- [`pipelines`](#pipelines) - Configure Cloudflare Pipelines.
3940
- [`queues`](#queues) - Configure Workers Queues.
4041
- [`login`](#login) - Authorize Wrangler with your Cloudflare account using OAuth.
4142
- [`logout`](#logout) - Remove Wrangler’s authorization for accessing your account.
@@ -1162,113 +1163,9 @@ wrangler pages secret bulk [<FILENAME>] [OPTIONS]
11621163
---
11631164

11641165
## `pipelines`
1165-
:::note
1166-
1167-
Pipelines is currently in open beta. Report Pipelines bugs in [GitHub](https://github.com/cloudflare/workers-sdk/issues/new/choose).
1168-
1169-
:::
1170-
11711166
Manage your [Pipelines](/pipelines/).
11721167

1173-
### `create`
1174-
1175-
Create a new pipeline
1176-
1177-
```txt
1178-
wrangler pipelines create <name> --r2 <r2-bucket-name> [OPTIONS]
1179-
```
1180-
1181-
- `name` <Type text="string" /> <MetaInfo text="required" />
1182-
- The name of the pipeline to create
1183-
- `--source` <Type text="array" /> <MetaInfo text="optional" />
1184-
- List of alowed sources. Options: 'http' and/or 'worker'
1185-
- `--require-http-auth` <Type text="boolean" /> <MetaInfo text="optional" />
1186-
- Require Cloudflare API token to authenticate with the HTTPS endpoint. Defaults to false.
1187-
- `--cors-origins` <Type text="array" /> <MetaInfo text="optional" />
1188-
- CORS Origin allowlist for HTTP endpoint. Allows `*`. Defaults to an empty array.
1189-
- `--batch-max-mb` <Type text="number" /> <MetaInfo text="optional" />
1190-
- The maximum size a batch before data is written, in megabytes. Defaults to 100. Must be between 0.001 and 100.
1191-
- `--batch-max-rows` <Type text="number" /> <MetaInfo text="optional" />
1192-
- The maximum number of rows in a batch before data is written. Defaults to 10000000. Must be between 1 and 10000000.
1193-
- `--batch-max-seconds` <Type text="number" /> <MetaInfo text="optional" />
1194-
- The maximum duration of a batch before data is written, in seconds. Defaults to 300. Must be between 1 and 300.
1195-
- `--r2-bucket` <Type text="string" /> <MetaInfo text="required" />
1196-
- The name of the R2 bucket used as the destination to store the data.
1197-
- `--r2-bucket-access-key-id` <Type text="string" /> <MetaInfo text="optional" />
1198-
- Access key ID used to authenticate with R2. Leave empty for oauth confirmation.
1199-
- `--r2-bucket-secret-access-key` <Type text="string" /> <MetaInfo text="optional" />
1200-
- Secret access key ID used to authenticate with R2. Leave empty for oauth confirmation.
1201-
- `--r2-prefix` <Type text="string" /> <MetaInfo text="optional" />
1202-
- Prefix for storing files in the destination bucket.
1203-
- `--compression` <Type text="string" /> <MetaInfo text="optional" />
1204-
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
1205-
- `--shard-count` <Type text="number" /> <MetaInfo text="optional" />
1206-
- Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2. Must be between 1 and 15.
1207-
1208-
### `update`
1209-
1210-
Update an existing pipeline
1211-
1212-
```txt
1213-
wrangler pipelines update <name> [OPTIONS]
1214-
```
1215-
1216-
- `name` <Type text="string" /> <MetaInfo text="required" />
1217-
- The name of the pipeline to create
1218-
- `--source` <Type text="array" /> <MetaInfo text="optional" />
1219-
- List of alowed sources. Options: 'http' and/or 'worker'
1220-
- `--require-http-auth` <Type text="boolean" /> <MetaInfo text="optional" />
1221-
- Require Cloudflare API token to authenticate with the HTTPS endpoint. Defaults to false.
1222-
- `--cors-origins` <Type text="array" /> <MetaInfo text="optional" />
1223-
- CORS Origin allowlist for HTTP endpoint. Allows `*`. Defaults to an empty array.
1224-
- `--batch-max-mb` <Type text="number" /> <MetaInfo text="optional" />
1225-
- The maximum size a batch before data is written, in megabytes. Defaults to 100. Must be between 0.001 and 100.
1226-
- `--batch-max-rows` <Type text="number" /> <MetaInfo text="optional" />
1227-
- The maximum number of rows in a batch before data is written. Defaults to 10000000. Must be between 1 and 10000000.
1228-
- `--batch-max-seconds` <Type text="number" /> <MetaInfo text="optional" />
1229-
- The maximum duration of a batch before data is written, in seconds. Defaults to 300. Must be between 1 and 300.
1230-
- `--r2-bucket` <Type text="string" /> <MetaInfo text="required" />
1231-
- The name of the R2 bucket used as the destination to store the data.
1232-
- `--r2-bucket-access-key-id` <Type text="string" /> <MetaInfo text="optional" />
1233-
- Access key ID used to authenticate with R2. Leave empty for oauth confirmation.
1234-
- `--r2-bucket-secret-access-key` <Type text="string" /> <MetaInfo text="optional" />
1235-
- Secret access key ID used to authenticate with R2. Leave empty for oauth confirmation.
1236-
- `--r2-prefix` <Type text="string" /> <MetaInfo text="optional" />
1237-
- Prefix for storing files in the destination bucket.
1238-
- `--compression` <Type text="string" /> <MetaInfo text="optional" />
1239-
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
1240-
- `--shard-count` <Type text="number" /> <MetaInfo text="optional" />
1241-
- Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2. Must be between 1 and 15.
1242-
1243-
### `get`
1244-
1245-
Get the configuration for an existing pipeline.
1246-
1247-
```txt
1248-
wrangler pipelines get <name> [OPTIONS]
1249-
```
1250-
1251-
- `name` <Type text="string" /> <MetaInfo text="required" />
1252-
- The name of the pipeline to inspect
1253-
1254-
### `delete`
1255-
1256-
Deletes an existing pipeline
1257-
1258-
```txt
1259-
wrangler pipelines delete <name> [OPTIONS]
1260-
```
1261-
1262-
- `name` <Type text="string" /> <MetaInfo text="required" />
1263-
- The name of the pipeline to delete
1264-
1265-
### `list`
1266-
1267-
Lists all pipelines in your account.
1268-
1269-
```txt
1270-
wrangler pipelines list [OPTIONS]
1271-
```
1168+
<Render file="wrangler-commands/pipelines" product="workers" />
12721169

12731170
## `queues`
12741171

Lines changed: 111 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,111 @@
1+
---
2+
{}
3+
---
4+
5+
import { Render, AnchorHeading, Type, MetaInfo } from "~/components";
6+
7+
:::note
8+
9+
Pipelines is currently in open beta. Report Pipelines bugs in [GitHub](https://github.com/cloudflare/workers-sdk/issues/new/choose).
10+
11+
:::
12+
13+
<AnchorHeading title="`create`" slug="pipelines-create" depth={3} />
14+
15+
Create a new pipeline
16+
17+
```txt
18+
wrangler pipelines create <name> --r2 <r2-bucket-name> [OPTIONS]
19+
```
20+
21+
- `name` <Type text="string" /> <MetaInfo text="required" />
22+
- The name of the pipeline to create
23+
- `--source` <Type text="array" /> <MetaInfo text="optional" />
24+
- List of alowed sources. Options: 'http' and/or 'worker'
25+
- `--require-http-auth` <Type text="boolean" /> <MetaInfo text="optional" />
26+
- Require Cloudflare API token to authenticate with the HTTPS endpoint. Defaults to false.
27+
- `--cors-origins` <Type text="array" /> <MetaInfo text="optional" />
28+
- CORS Origin allowlist for HTTP endpoint. Allows `*`. Defaults to an empty array.
29+
- `--batch-max-mb` <Type text="number" /> <MetaInfo text="optional" />
30+
- The maximum size a batch before data is written, in megabytes. Defaults to 100. Must be between 0.001 and 100.
31+
- `--batch-max-rows` <Type text="number" /> <MetaInfo text="optional" />
32+
- The maximum number of rows in a batch before data is written. Defaults to 10000000. Must be between 1 and 10000000.
33+
- `--batch-max-seconds` <Type text="number" /> <MetaInfo text="optional" />
34+
- The maximum duration of a batch before data is written, in seconds. Defaults to 300. Must be between 1 and 300.
35+
- `--r2-bucket` <Type text="string" /> <MetaInfo text="required" />
36+
- The name of the R2 bucket used as the destination to store the data.
37+
- `--r2-bucket-access-key-id` <Type text="string" /> <MetaInfo text="optional" />
38+
- Access key ID used to authenticate with R2. Leave empty for oauth confirmation.
39+
- `--r2-bucket-secret-access-key` <Type text="string" /> <MetaInfo text="optional" />
40+
- Secret access key ID used to authenticate with R2. Leave empty for oauth confirmation.
41+
- `--r2-prefix` <Type text="string" /> <MetaInfo text="optional" />
42+
- Prefix for storing files in the destination bucket.
43+
- `--compression` <Type text="string" /> <MetaInfo text="optional" />
44+
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
45+
- `--shard-count` <Type text="number" /> <MetaInfo text="optional" />
46+
- Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2. Must be between 1 and 15.
47+
48+
<AnchorHeading title="`update`" slug="pipelines-update" depth={3} />
49+
50+
Update an existing pipeline
51+
52+
```txt
53+
wrangler pipelines update <name> [OPTIONS]
54+
```
55+
56+
- `name` <Type text="string" /> <MetaInfo text="required" />
57+
- The name of the pipeline to create
58+
- `--source` <Type text="array" /> <MetaInfo text="optional" />
59+
- List of alowed sources. Options: 'http' and/or 'worker'
60+
- `--require-http-auth` <Type text="boolean" /> <MetaInfo text="optional" />
61+
- Require Cloudflare API token to authenticate with the HTTPS endpoint. Defaults to false.
62+
- `--cors-origins` <Type text="array" /> <MetaInfo text="optional" />
63+
- CORS Origin allowlist for HTTP endpoint. Allows `*`. Defaults to an empty array.
64+
- `--batch-max-mb` <Type text="number" /> <MetaInfo text="optional" />
65+
- The maximum size a batch before data is written, in megabytes. Defaults to 100. Must be between 0.001 and 100.
66+
- `--batch-max-rows` <Type text="number" /> <MetaInfo text="optional" />
67+
- The maximum number of rows in a batch before data is written. Defaults to 10000000. Must be between 1 and 10000000.
68+
- `--batch-max-seconds` <Type text="number" /> <MetaInfo text="optional" />
69+
- The maximum duration of a batch before data is written, in seconds. Defaults to 300. Must be between 1 and 300.
70+
- `--r2-bucket` <Type text="string" /> <MetaInfo text="required" />
71+
- The name of the R2 bucket used as the destination to store the data.
72+
- `--r2-bucket-access-key-id` <Type text="string" /> <MetaInfo text="optional" />
73+
- Access key ID used to authenticate with R2. Leave empty for oauth confirmation.
74+
- `--r2-bucket-secret-access-key` <Type text="string" /> <MetaInfo text="optional" />
75+
- Secret access key ID used to authenticate with R2. Leave empty for oauth confirmation.
76+
- `--r2-prefix` <Type text="string" /> <MetaInfo text="optional" />
77+
- Prefix for storing files in the destination bucket.
78+
- `--compression` <Type text="string" /> <MetaInfo text="optional" />
79+
- Type of compression to apply to output files. Choices: "none", "gzip", "deflate"
80+
- `--shard-count` <Type text="number" /> <MetaInfo text="optional" />
81+
- Number of pipeline shards. More shards handle higher request volume; fewer shards produce larger output files. Defaults to 2. Must be between 1 and 15.
82+
83+
<AnchorHeading title="`get`" slug="pipelines-get" depth={3} />
84+
85+
Get the configuration for an existing pipeline.
86+
87+
```txt
88+
wrangler pipelines get <name> [OPTIONS]
89+
```
90+
91+
- `name` <Type text="string" /> <MetaInfo text="required" />
92+
- The name of the pipeline to inspect
93+
94+
<AnchorHeading title="`delete`" slug="pipelines-delete" depth={3} />
95+
96+
Deletes an existing pipeline
97+
98+
```txt
99+
wrangler pipelines delete <name> [OPTIONS]
100+
```
101+
102+
- `name` <Type text="string" /> <MetaInfo text="required" />
103+
- The name of the pipeline to delete
104+
105+
<AnchorHeading title="`list`" slug="pipelines-list" depth={3} />
106+
107+
Lists all pipelines in your account.
108+
109+
```txt
110+
wrangler pipelines list [OPTIONS]
111+
```

0 commit comments

Comments
 (0)