search

carvel-dev / carvel

Carvel provides a set of reliable, single-purpose, composable tools that aid in your application building, configuration, and deployment to Kubernetes. This repo contains information regarding the Carvel open-source community.
https://carvel.dev/
Apache License 2.0
369 stars 108 forks source link

Enhance Mozilla SOPS Integration docs #712

Open asaikali opened 8 months ago

asaikali commented 8 months ago

The Integration with Mozilla's sops](https://carvel.dev/kapp-controller/docs/v0.48.x/sops/) docs jumps straight into a how-to instructions with no high level explanation of how the the integration works. The docs currently assume the reader already knows kapp-controller and Mozilla SOPS.

The SOPS doc page should have a small section added at the start of the doc that explains at a high level how the integration work. parts of this section are:

  1. brief explanation of mozilla sops
  2. brief explanation of the fetch / template / deploy life cycle of kapp-controller and where SOPS integrates into the lifecyle
  3. Steps of the workflow for adding a secret via SOPS, the steps should not explain the how just the main steps. The rest of the doc will explain how to accomplish the steps. We are trying to help the users understand the sequence of steps they need to go through.
  4. Steps of the workflow for updating a secret after it has been added, only high level steps not how to do it. The how should be explained in the rest of the doc.
github-actions[bot] commented 7 months ago

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.

renuy commented 6 months ago

Moving issue to Carvel repo for changes to documentation