Skip to content

Create deployment guide and Helm chart #298

@kishoregv

Description

@kishoregv

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]

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions