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

Create deployment guide and Helm chart #298

Open
kishoregv opened this issue Nov 17, 2023 · 0 comments
Open

Create deployment guide and Helm chart #298

kishoregv opened this issue Nov 17, 2023 · 0 comments

Comments

@kishoregv
Copy link
Contributor

User Story

As a user of this Kubernetes open source project, I want a deployment guide and Helm chart so I can easily install and configure the project in my Kubernetes cluster.

Description

We need to create docs and assets to make deployment of this project simpler for users.

Deployment Guide

  • Document steps for deployment
    • Prerequisites (K8s version, resources, etc)
    • Install with YAML manifests
    • Install with Helm
  • Include examples and commands for:
    • Creating namespaces/service accounts
    • Applying RBAC
    • Creating configmaps/secrets
    • Deploying applications
    • Accessing services

Helm Chart

  • Package Kubernetes manifests into a Helm chart
    • Support customizable namespace
    • Parameterize resource requests/limits
    • Parameterize replicas
    • Include CHANGELOG and README
  • Add to chart repository

Acceptance Criteria

  • Deployment guide doc added to docs/deploy.md
  • Helm chart published to [repo]
  • Doc updated with install instructions using Helm chart
  • Installation and configuration via Helm and docs steps tested and confirmed

Links

  • Chart repo: [link]
  • Docs: [link]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant