zarf icon indicating copy to clipboard operation
zarf copied to clipboard

Add Zarf Features to Docs Overview pg.

Open Madeline-UX opened this issue 2 years ago • 3 comments

Description

Add a section on the Docs overview (home page) listing out the features of Zarf.

  • out of the box
  • configurable

Related Issue

  • [ ] New feature (non-breaking change which adds functionality)

Checklist before merging

  • [x] Documentation has been updated as necessary (add the needs-docs label)

Madeline-UX avatar Jul 19 '22 22:07 Madeline-UX

We should tagup on this next week sometime, some of these features are a good fit, but I think some are too in the details and should be better summarized.

jeff-mccoy avatar Jul 25 '22 03:07 jeff-mccoy

@jeff-mccoy Sounds great. Will plan to discuss this during Tuesday's office hours.

Madeline-UX avatar Jul 25 '22 18:07 Madeline-UX

@jeff-mccoy Here is a working list of features that I have collected

📦 Out of the Box Features

  • Automates Kubernetes orchestration in disconnected environements.
  • Automates SBOM Generation
  • UI Dashboard for viewing SBOM findings
  • Deploy a cluster while fully disconnected (using K3s)
  • Deploy pre-built tar.zst package onto a machine or server (specifically into a k8s cluster)
  • Built in Logging
  • Seed Git Registry
  • Automatically update pod's ImagePullSecrets so deployed resources use the NodePort binding. See Zarf Agent.
  • K9 Dashboard for visualizing containers and clusters
  • Finds images and resources from helm chart
  • Creates secure tunnel ports for deployments

🛠️ Configurable Features

  • Manage CPU usage
  • Mount onto existing cluster
  • Customize packages variables

Madeline-UX avatar Jul 29 '22 20:07 Madeline-UX

@Madeline-UX Do you want to tag up this sometime this week? I'd love to help get this added to the docs.

And question for whenever we have time to talk; do we want to differentiate the features of 'Zarf the CLI' and 'the released Initialization Package'? The features listed above are a mix between the two which might be confusing for some.

YrrepNoj avatar Aug 15 '22 17:08 YrrepNoj

Closing as these are covered by other PRs now.

jeff-mccoy avatar Aug 22 '22 07:08 jeff-mccoy

@jeff-mccoy Is there a reason I am not seeing the merged changes updated on the Docs overview site?

Madeline-UX avatar Aug 23 '22 16:08 Madeline-UX