rstudio / rstudio/helm

Support for adding annotations to deployment spec to Package Manager

Open Beginner friendly
#804 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

team: package manager
Dominant language
Markdown
Stars
46
Forks
40
Avg merge
4h 3m
Merged PRs (30d)
6

Description

Description

Users would like the ability to add annotations to the deployment spec. Right now it's possible to add annotations to the pod spec and to the service spec, but not the deployment spec.

apiVersion: apps/v1
kind: Deployment
metadata:
  annotations:
    reloader.stakater.com/auto: "true"

This request arose because I was talking to a user who is using a tool (https://github.com/stakater/Reloader) to automate redeployments when a secret changes. But that tool depends on an annotation being set on a deployment.

Approach

  • Add new top level item to values.yaml:
deployment:
    annotations: {}
  • Update the deployment template (https://github.com/rstudio/helm/blob/main/charts/rstudio-pm/templates/deployment.yaml) to add annotations set in values.yaml.

Related

I already completed this work for Connect. See, this pull request: https://github.com/rstudio/helm/pull/794

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with charts/rstudio-pm/values.yaml and charts/rstudio-pm/templates/deployment.yaml, and compare the related Connect change in pull request #794. Done means users can configure deployment annotations through values.yaml and the deployment spec receives them.

Written by the indexing model from the issue text.

Assessment

Tech stack
helm, kubernetes
Domain
devops, infrastructure
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.