Generate informational header at top of YAML file. #71
Conversation
This file contains 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
rgrandl
approved these changes
Oct 17, 2023
| @@ -489,6 +495,82 @@ func GenerateYAMLs(image string, app *protos.AppConfig, depId string, cfg *KubeC | |||
| return nil | |||
| } | |||
|
|
|||
| // header returns the informational header at the top of a generated YAML file. | |||
| func header(app *protos.AppConfig, cfg *KubeConfig, depId, filename string) (string, error) { | |||
| header := template.Must(template.New("header").Parse(`# This file was generated by "weaver kube" version {{.ToolVersion}} for the following | |||
There was a problem hiding this comment.
I was thinking whether long term we should also provide more k8s stuff. E.g., for every deployment, stuff like cpu/memory request/limit, env variables set for the pods, min/max #replicas, volume mounts. Maybe for HPA, which rules apply. If someone takes a quick look at the header can get a good understanding of the high-level things that would happen if they deploy the yaml.
There was a problem hiding this comment.
Sounds like a good idea to me! I'll do this in a future PR.
mwhittaker
commented
Oct 17, 2023
| @@ -489,6 +495,82 @@ func GenerateYAMLs(image string, app *protos.AppConfig, depId string, cfg *KubeC | |||
| return nil | |||
| } | |||
|
|
|||
| // header returns the informational header at the top of a generated YAML file. | |||
| func header(app *protos.AppConfig, cfg *KubeConfig, depId, filename string) (string, error) { | |||
| header := template.Must(template.New("header").Parse(`# This file was generated by "weaver kube" version {{.ToolVersion}} for the following | |||
There was a problem hiding this comment.
Sounds like a good idea to me! I'll do this in a future PR.
This PR changes `weaver kube deploy` to add an informational header at
the top of every generated YAML file. It looks like this:
# This file was generated by "weaver kube" version (devel) for the following
# application:
#
# app: collatz
# version: 79f011d4
# components:
# - github.com/ServiceWeaver/weaver/Main
# - github.com/ServiceWeaver/weaver/examples/collatz/Even
# - github.com/ServiceWeaver/weaver/examples/collatz/Odd
# listeners:
# - collatz
#
# This file contains the following resources:
#
# 1. A Deployment for every group of components.
# 2. A HorizontalPodAutoscaler for every Deployment.
# 3. A Service for every listener.
# 4. Some Roles and RoleBindings to configure permissions.
#
# To deploy these resources, run:
#
# kubectl apply -f /tmp/kube_79f011d4.yaml
#
# To view the deployed resources, run:
#
#
# kubectl delete all --selector=version=79f011d4
...
# This file was generated by "weaver kube" version (devel) for the following
# application:
#
# app: collatz
# version: 8edb402a
# components groups:
# -
# - github.com/ServiceWeaver/weaver/Main
# -
# - github.com/ServiceWeaver/weaver/examples/collatz/Even
# - github.com/ServiceWeaver/weaver/examples/collatz/Odd
# listeners:
# - collatz (github.com/ServiceWeaver/weaver/Main)
#
# This file contains the following resources:
#
# 1. A Deployment for every group of components.
# 2. A HorizontalPodAutoscaler for every Deployment.
# 3. A Service for every listener.
# 4. Some Roles and RoleBindings to configure permissions.
#
# To deploy these resources, run:
#
# kubectl apply -f /tmp/kube_8edb402a.yaml
#
# To view the deployed resources, run:
#
# kubectl get all --selector=version=8edb402a
#
# To delete the resources, run:
#
# kubectl delete all --selector=version=8edb402a
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.
This PR changes
weaver kube deployto add an informational header at the top of every generated YAML file. It looks like this: