Skip to content

Commit fc66eaf

Browse files
docs(cloud): add INIT_CONFIG environment variable documentation to deployment guide
Co-authored-by: pontusringblom <[email protected]>
1 parent c31227c commit fc66eaf

File tree

1 file changed

+49
-1
lines changed
  • content/en/cloud/self-hosted/deployment

1 file changed

+49
-1
lines changed

content/en/cloud/self-hosted/deployment/_index.md

Lines changed: 49 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,55 @@ tags: [helm]
66
weight: 2
77
---
88

9-
## High-level List of Deployment Tasks
9+
## High-level List of Deployment
10+
11+
## Environment Variables
12+
13+
### INIT_CONFIG
14+
15+
The `INIT_CONFIG` environment variable allows you to configure the initial setup of your self-hosted Layer5 Cloud provider. This variable accepts a JSON string that defines the provider initialization configuration.
16+
17+
#### Purpose
18+
19+
`INIT_CONFIG` enables you to:
20+
- Pre-configure provider settings during deployment
21+
- Automate initial setup for consistent deployments
22+
- Define custom provider configurations without manual intervention
23+
24+
#### Usage
25+
26+
Set the `INIT_CONFIG` environment variable with a JSON configuration string:
27+
28+
```bash
29+
export INIT_CONFIG='{"provider": {"name": "my-provider", "settings": {...}}}'
30+
```
31+
32+
For Docker deployments:
33+
34+
```bash
35+
docker run -e INIT_CONFIG='{"provider": {"name": "my-provider"}}' layer5/meshery-cloud
36+
```
37+
38+
For Kubernetes deployments, add to your deployment manifest:
39+
40+
```yaml
41+
env:
42+
- name: INIT_CONFIG
43+
value: '{"provider": {"name": "my-provider", "settings": {...}}}'
44+
```
45+
46+
{{< alert type="info" title="Note" >}}
47+
The INIT_CONFIG variable is only processed during the initial startup. Subsequent restarts will not reprocess this configuration.
48+
{{< /alert >}}
49+
50+
#### Configuration Schema
51+
52+
The `INIT_CONFIG` JSON structure supports the following fields:
53+
54+
- `provider.name`: The name of your provider instance
55+
- `provider.settings`: Custom provider settings specific to your deployment
56+
57+
For detailed configuration options, refer to the [provider initialization documentation](https://github.com/layer5io/meshery-cloud/blob/master/docs/provider-init.md). Tasks
1058

1159
<ol>
1260
<li>Review the prequisites for installing Layer5 Cloud on Kubernetes. (<a href="#prerequisites">docs</a>)</li>

0 commit comments

Comments
 (0)