Allow custom markers with values
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 42/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- go, kubernetes
- Domain
- documentation
Research direction
The issue points to processor.customMarkers and the templates used by the examples; start by tracing how custom markers are matched when a marker has an equals sign. Confirm that an env marker value such as MAX_OPEN_CONNS is available to the templates and produces the requested extra column.
Written by the indexing model from the issue text.
Description
Allow custom markers to have a value like kubebuilder markers.
type Config struct {
// +kubebuilder:default=25
MaxOpenConns int `json:"maxOpenConns,omitempty"`
}
Motivation is to define an env custom marker to generate an extra column with the equivalent environment variable name.
type Config struct {
// +env="MAX_OPEN_CONNS"
MaxOpenConns int `json:"maxOpenConns,omitempty"`
}
I tried implementing this using the existing processor.customMarkers config and modified templates like the examples, but it seems like the markers are not matched if they are followed by an equals sign.
- Dominant language
- Go
- Stars
- 174
- Forks
- 81
- PR merge metrics
- No merged PRs in 30d
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from elastic/crd-ref-docs
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
elastic/crd-ref-docs#204 ·
-
Support for +kubebuilder:validation:Required and omitemptyPossibly taken @swathinsankaran claimed this 112 days ago. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
elastic/crd-ref-docs#198 · 1 reaction ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#191 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#188 · 2 comments ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
elastic/crd-ref-docs#182 ·
All issues in elastic/crd-ref-docs
Similar issues
-
raised-by:reviewer
Difficulty 1/5 1-3 hours Newbie friendliness 84/100
medici-finance/assay#2681 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 82/100
homarr-labs/dashboard-icons#2939 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
AvengeMedia/DankMaterialShell#3761 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
Maintainers usually reply within 1 day
-
docs: clarify replacement for outdated Terms of Service URL in readme.mdPossibly taken @mohitjoshi-hey claimed this today. Open
Difficulty 1/5 1-3 hours Newbie friendliness 66/100