Skip to content

Commit 3b1d116

Browse files
committed
docs: add docs according to the pulumi standard
1 parent 9fcda1d commit 3b1d116

File tree

8 files changed

+95
-6
lines changed

8 files changed

+95
-6
lines changed

docs/_index.md

Lines changed: 52 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,58 @@
11
---
22
title: Clickhouse
33
meta_desc: Provides an overview of the Clickhouse Provider for Pulumi.
4-
layout: overview
4+
layout: package
55
---
66

7-
The Clickhouse provider for Pulumi can be used to provision any of the cloud resources available in Clickhouse.
7+
The Clickhouse provider for Pulumi can be used to provision any of the cloud resources available in [Clickhouse Cloud](https://clickhouse.cloud).
88

9-
The Clickhouse provider must be configured with credentials to deploy and update resources in Clickhouse.
9+
The Clickhouse provider must be configured with credentials to deploy and update resources in Clickhouse Cloud.
10+
11+
## Example
12+
13+
{{< chooser language "typescript,python" >}}
14+
{{% choosable language typescript %}}
15+
16+
```typescript
17+
import * as clickhouse from "@pulumiverse/clickhouse";
18+
19+
new clickhouse.Service("example", {
20+
region: "us-central1",
21+
cloudProvider: "gcp",
22+
tier: "development",
23+
password: "1234",
24+
ipAccesses: [{
25+
source: "0.0.0.0",
26+
description: "Test IP"
27+
}]
28+
});
29+
30+
```
31+
32+
{{% /choosable %}}
33+
{{% choosable language python %}}
34+
35+
```python
36+
import pulumiverse_clickhouse as clickhouse
37+
38+
service_account = clickhouse.Service(
39+
"example",
40+
region = "us-central1",
41+
cloud_provider = "gcp",
42+
tier = "development",
43+
password = "1234",
44+
ip_accesses = [{
45+
"source": "0.0.0.0",
46+
"description": "Test IP"
47+
}]
48+
)
49+
```
50+
51+
{{% /choosable %}}
52+
{{< /chooser >}}
53+
54+
## Issues
55+
56+
This is a community maintained provider. Please file issues and feature requests here:
57+
58+
[pulumiverse/pulumi-clickhouse](https://github.com/pulumiverse/pulumi-clickhouse/issues)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
*.pyc
2+
venv/
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
name: py
2+
runtime:
3+
name: python
4+
options:
5+
toolchain: pip
6+
virtualenv: venv
7+
description: A minimal Python Pulumi program
8+
config:
9+
pulumi:tags:
10+
value:
11+
pulumi:template: python
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
"""A Python Pulumi program"""
2+
3+
import pulumiverse_clickhouse as clickhouse
4+
5+
service_account = clickhouse.Service(
6+
"example",
7+
region = "us-central1",
8+
cloud_provider = "gcp",
9+
tier = "development",
10+
password = "1234",
11+
ip_accesses = [{
12+
"source": "0.0.0.0",
13+
"description": "Test IP"
14+
}]
15+
)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
pulumi>=3.0.0,<4.0.0
2+
pulumiverse_clickhouse>=0.0.4,

examples/create-clickhouse-service/ts/index.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
import * as pulumi from "@pulumi/pulumi";
21
import * as clickhouse from "@pulumiverse/clickhouse";
32

43
new clickhouse.Service("example", {

examples/create-clickhouse-service/ts/package-lock.json

Lines changed: 11 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

examples/create-clickhouse-service/ts/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
"typescript": "^5.0.0"
77
},
88
"dependencies": {
9-
"@pulumi/pulumi": "^3.113.0"
9+
"@pulumi/pulumi": "^3.113.0",
10+
"@pulumiverse/clickhouse": "^0.0.4"
1011
}
1112
}

0 commit comments

Comments
 (0)