Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove hints from printed yaml #2974

Open
AustinAbro321 opened this issue Sep 6, 2024 · 0 comments
Open

Remove hints from printed yaml #2974

AustinAbro321 opened this issue Sep 6, 2024 · 0 comments
Labels
enhancement ✨ New feature or request

Comments

@AustinAbro321
Copy link
Contributor

AustinAbro321 commented Sep 6, 2024

Is your feature request related to a problem? Please describe.

Currently when we print a package on create or on deploy we add hints to the printed yaml. There is a bug with how the hints are displayed which can be seen below. Variables the sub-key on charts and variables the package level key have the same name so the hint for variables the package level key shows up on variables the subkey on charts.

The feedback I've received from users, and that I personally agree, with is that these hints don't add much, and they would rather just get the package. While we could fix the variables issue, I would rather remove the hints all together.

kind: ZarfPackageConfig

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
metadata:  information about this package

  name: helm-charts
  description: Example showcasing multiple ways to deploy helm charts
  version: 0.0.1
  architecture: amd64

━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
components:  components selected for this operation

- name: demo-helm-charts
  required: true
  charts:
  - name: podinfo-local
    version: 6.4.0
    localPath: chart
    namespace: podinfo-from-local-chart
    valuesFiles:
    - values.yaml
    
━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
variables:  deployment-specific values that are set on each package deployment
    - name: REPLICA_COUNT
      description: Override the number of pod replicas
      path: replicaCount
  - name: podinfo-oci
    version: 6.4.0
    url: oci://ghcr.io/stefanprodan/charts/podinfo
    namespace: podinfo-from-oci
    valuesFiles:
    - values.yaml

Alternatives considered

I've considered removing the print yaml of the package all together, however it may be useful to those deploying, and those who use compose and package templates.

@AustinAbro321 AustinAbro321 added the enhancement ✨ New feature or request label Sep 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement ✨ New feature or request
Projects
Status: Backlog
Development

No branches or pull requests

1 participant