docs(resources): add HostnameGenerator reference#2557
Merged
Conversation
Add comprehensive HostnameGenerator resource documentation covering: - Spec fields (selector, template, extension) - Template variables (.DisplayName, .Namespace, .Zone, .Mesh, label function) - Status fields (addresses) - Examples for MeshService, MeshExternalService, MeshMultiZoneService - Integration with existing networking guide Includes schema viewer integration for complete CRD reference. Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
✅ Deploy Preview for kuma ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
bartsmykla
approved these changes
Nov 28, 2025
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Include staged and unstaged changes in vale:branch task to catch issues before commit. Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Consistent with vale:branch - check staged and unstaged changes. Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive reference documentation for the HostnameGenerator resource to help users understand how to generate custom DNS hostnames for service resources. The documentation complements the existing HostnameGenerator guide by providing detailed field descriptions and practical examples.
Key Changes
- Added complete HostnameGenerator resource reference documentation with spec/status field tables
- Included multiple examples showing different use cases (basic, with namespaces/zones, with label functions, and for different service types)
- Added HostnameGenerator to the Core Resources section of the 2.13.x navigation
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| app/_src/resources/hostnamegenerator.md | New comprehensive reference documentation for HostnameGenerator with spec/status fields, template variables, examples for all service types (MeshService, MeshExternalService, MeshMultiZoneService), related links, and CRD schema viewer |
| app/_data/docs_nav_kuma_2.13.x.yml | Added HostnameGenerator entry to Core Resources section in documentation navigation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
- Updated all example section headings to use full resource name "HostnameGenerator" - Added "HostnameGenerator" to Vale accept list for proper noun recognition Signed-off-by: Marcin Skalski <skalskimarcin33@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Add comprehensive reference documentation for HostnameGenerator resource to provide users with detailed spec/status field descriptions and examples.
Implementation information
mise new:resource HostnameGeneratorSupporting documentation