ServiceWeaver / weaver-kube

Run Service Weaver applications on vanilla Kubernetes.
Apache License 2.0
61 stars 19 forks source link

Generate informational header at top of YAML file. #71

Closed mwhittaker closed 12 months ago

mwhittaker commented 12 months ago

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
...