docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments #879

Copilot · 2025-12-15T21:47:50Z

Documentation Update for INIT_CONFIG Environment Variable

Explore repository structure and locate existing self-hosted documentation
Review the deployment page at /content/en/cloud/self-hosted/deployment/
Add INIT_CONFIG environment variable documentation to deployment page
Review and update the planning guide with configuration planning section
Fix frontmatter structure in planning guide (moved content from frontmatter to body)
Validate Hugo build succeeds (requires maintainer validation)

Changes Made

1. Deployment Guide (`/content/en/cloud/self-hosted/deployment/_index.md`)

Added comprehensive Environment Variables section with INIT_CONFIG documentation:

Purpose: Pre-configure provider settings, automate setup, define custom configurations
Usage Examples:
- Bash/shell environment variable export
- Docker deployment with -e flag
- Kubernetes deployment with env variables in manifest
Configuration Schema: Provider name and settings structure
Reference Link: Links to detailed provider-init.md in meshery-cloud repository

2. Planning Guide (`/content/en/cloud/self-hosted/planning/_index.md`)

Added Provider Configuration Planning section:

Configuration Strategy: Planning checklist for provider identity, initial settings, config management
INIT_CONFIG Benefits: Reproducible deployments, CI/CD integration, Infrastructure as Code
Important Considerations: Startup-only processing warning
Cross-reference: Links to deployment guide for detailed usage
Fixed: Corrected frontmatter structure - content now properly in body, not frontmatter

Documentation Principles Applied

✅ Diátaxis Framework: Deployment guide follows "How-to" pattern; Planning guide follows "Explanation" pattern
✅ Minimal Changes: Only added new sections, preserved all existing content
✅ Professional Tone: Clear, concise, welcoming to technical audiences
✅ Accessibility: Proper heading hierarchy, descriptive text, semantic structure
✅ Hugo Compliance: Valid shortcodes, proper frontmatter, Markdown syntax
✅ Cross-referencing: Links between planning and deployment guides for better navigation

References

Issue requirement: https://github.com/layer5io/meshery-cloud/pull/4652
Provider init docs: https://github.com/layer5io/meshery-cloud/blob/e055f067706e7c376dc77e03d224af90a0cfb2d6/docs/provider-init.md

Original prompt

This section details on the original issue you should resolve

<issue_title>[Docs] Update self-hosted deployment instructions with new</issue_title>
<issue_description>#### Current State
This page needs updated: https://docs.layer5.io/cloud/self-hosted/deployment/.

Maybe a new page needs to be added to the planning guide - https://docs.layer5.io/cloud/self-hosted/planning/

Desired State

Incorporate user-facing documentation about the purpose and use of the INIT_CONFIG environment variable. References:

https://github.com/layer5io/meshery-cloud/pull/4652#issue-3731818019

https://github.com/layer5io/meshery-cloud/blob/e055f067706e7c376dc77e03d224af90a0cfb2d6/docs/provider-init.md

Contributor Guide and Resources

📚 Instructions for contributing to documentation

Layer5 documentation site and source

🎨 Wireframes and designs for Layer5 site in Figma (open invite)

🙋🏾🙋🏼 Questions: Layer5 Discussion Forum and Layer5 Community Slack
</issue_description>

Comments on the Issue (you are @copilot in this section)

Custom agent used: Diátaxis Documentation Expert
Diátaxis Documentation Expert. An expert technical writer specializing in creating high-quality software documentation, guided by the principles and structure of the Diátaxis technical documentation authoring framework.

Fixes [Docs] Update self-hosted deployment instructions with new #878

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

netlify · 2025-12-15T21:48:14Z

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Name	Link
🔨 Latest commit	`8f443c7`
🔍 Latest deploy log	https://app.netlify.com/projects/bejewelled-pegasus-b0ce81/deploys/694087cdbcf00d0008a9d975
😎 Deploy Preview	https://deploy-preview-879--bejewelled-pegasus-b0ce81.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copilot

Copilot wasn't able to review any files in this pull request.

…ployment guide Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

leecalcote · 2025-12-15T22:01:37Z

@aabidsofi19, should serverbaseURL come under this section?

pontusringblom · 2025-12-15T22:09:23Z

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

@@ -1,5 +1,32 @@
 ---
-title: Planning Layer5 Cloud Deployment
+title: Planning


@copilot don't change the title.

Fixed in commit 8f443c7. The title is now preserved as "Planning" and the frontmatter structure is correct.

pontusringblom · 2025-12-15T22:09:43Z

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

+
+## Provider Configuration Planning
+
+When planning your self-hosted Layer5 Cloud deployment, consider how you will initialize and configure your provider instance. The `INIT_CONFIG` environment variable enables you to automate provider configuration during deployment.
+
+### Configuration Strategy
+
+Before deploying, plan your configuration approach:
+
+1. **Provider Identity**: Define your provider name and identification
+2. **Initial Settings**: Determine which settings need to be configured at startup
+3. **Configuration Management**: Decide how configuration will be managed (environment variables, secrets, config files)
+4. **Update Strategy**: Plan for configuration updates and changes over time
+
+### Using INIT_CONFIG for Automated Setup
+
+The `INIT_CONFIG` environment variable allows you to pre-configure your provider during deployment, eliminating manual setup steps. This is particularly valuable for:
+
+- **Reproducible Deployments**: Ensure consistent configuration across environments
+- **CI/CD Integration**: Automate deployments with predefined configurations
+- **Infrastructure as Code**: Manage provider configuration alongside your infrastructure
+
+For detailed usage and examples, see the [Deployment Guide](/cloud/self-hosted/deployment/#init_config).
+
+{{< alert type="warning" title="Important" >}}
+Plan your INIT_CONFIG carefully as it is only processed during initial startup. Changes require redeployment or manual configuration updates.
+{{< /alert >}} Layer5 Cloud Deployment


This should not be included in the frontmatter, but should be in the body, @copilot.

Fixed in commit 8f443c7. The Provider Configuration Planning section is now properly placed in the body after the frontmatter closes with ---.

Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

Initial plan

c31227c

Copilot AI assigned Copilot and pontusringblom Dec 15, 2025

Copilot started work on behalf of pontusringblom December 15, 2025 21:48 View session

pontusringblom marked this pull request as ready for review December 15, 2025 21:49

Copilot AI review requested due to automatic review settings December 15, 2025 21:49

Copilot AI reviewed Dec 15, 2025

View reviewed changes

Copilot AI and others added 2 commits December 15, 2025 21:52

docs(cloud): add INIT_CONFIG environment variable documentation to de…

fc66eaf

…ployment guide Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

docs(cloud): add provider configuration planning guide for INIT_CONFIG

723d23a

Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Update self-hosted deployment instructions with INIT_CONFIG details~~ docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments Dec 15, 2025

Copilot AI requested a review from pontusringblom December 15, 2025 21:55

Copilot finished work on behalf of pontusringblom December 15, 2025 21:55

github-actions bot added component/cloud-docs component/kanvas-docs labels Dec 15, 2025

leecalcote requested a review from aabidsofi19 December 15, 2025 22:01

pontusringblom requested changes Dec 15, 2025

View reviewed changes

Copilot started work on behalf of pontusringblom December 15, 2025 22:10 View session

fix(cloud): correct frontmatter structure in planning guide

8f443c7

Co-authored-by: pontusringblom <170570911+pontusringblom@users.noreply.github.com>

Copilot AI requested a review from pontusringblom December 15, 2025 22:13

Copilot finished work on behalf of pontusringblom December 15, 2025 22:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments #879

docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments #879

Uh oh!

Copilot AI commented Dec 15, 2025 •

edited

Loading

Uh oh!

netlify bot commented Dec 15, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

leecalcote commented Dec 15, 2025

Uh oh!

pontusringblom Dec 15, 2025

Uh oh!

Copilot AI Dec 15, 2025

Uh oh!

pontusringblom Dec 15, 2025

Uh oh!

Copilot AI Dec 15, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments #879

Are you sure you want to change the base?

docs(cloud): add INIT_CONFIG environment variable documentation for self-hosted deployments #879

Uh oh!

Conversation

Copilot AI commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Documentation Update for INIT_CONFIG Environment Variable

Changes Made

1. Deployment Guide (/content/en/cloud/self-hosted/deployment/_index.md)

2. Planning Guide (/content/en/cloud/self-hosted/planning/_index.md)

Documentation Principles Applied

References

Desired State

Contributor Guide and Resources

Comments on the Issue (you are @copilot in this section)

Uh oh!

netlify bot commented Dec 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for bejewelled-pegasus-b0ce81 ready!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

leecalcote commented Dec 15, 2025

Uh oh!

pontusringblom Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

pontusringblom Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 15, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Dec 15, 2025 •

edited

Loading

1. Deployment Guide (`/content/en/cloud/self-hosted/deployment/_index.md`)

2. Planning Guide (`/content/en/cloud/self-hosted/planning/_index.md`)

netlify bot commented Dec 15, 2025 •

edited

Loading