Hacktoberfest 2026: the issues maintainers tagged for October, open and beginner-friendly. Browse Hacktoberfest issues

docs(enterprise): extend Jira Data Center guide with Helm install path, ENABLE_JIRA_DC flag, and operator troubleshooting

Open
  • Is something wrong?
#537 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Quiet
Tech stack
helm, kubernetes, postgresql
Domain
databases, devops, documentation

Research direction

Start with enterprise/integrations/jira-data-center.mdx and review the related material from closed PR #527. Verify the Helm details against charts/openhands/templates/_env.yaml and charts/openhands-secrets/templates/jira-dc-app.yaml, including the feature flag, secret keys, environment check, references, and troubleshooting recipes. Done means the existing Replicated guide has additive Helm tabs and all five requested operator-focused additions.

Written by the indexing model from the issue text.

Description

documentation

Background

enterprise/integrations/jira-data-center.mdx (added in #532) documents the Jira Data Center integration end-to-end for the Replicated / KOTS Admin Console install path. The page is the right entry point and should stay that way.

This issue tracks a focused operator-facing follow-up that adds the missing material on top of that page — primarily for customers running OpenHands Enterprise via standalone Helm (e.g. C3.ai on GKE) and for support cases the current troubleshooting table doesn't cover. Framed as a diff/extension of the existing page, not a replacement.

Scope was carved out of closed PR #527, which #532 superseded.

What to add

1. Standalone Helm install path

Today's page is Replicated-only — there's no values.yaml guidance, so Helm-only customers can't follow it. Add a Helm tab alongside each Admin Console step covering:

  • openhands chart: jiraDc.enabled, jiraDc.linkMethod (oauth | email)
  • openhands-secrets chart: the resulting Secret/jira-dc-app and the keys it must contain
  • Operators who manage jira-dc-app directly (e.g. External Secrets / Vault) — what keys are read

Source of truth: charts/openhands/templates/_env.yaml, charts/openhands-secrets/templates/jira-dc-app.yaml in OpenHands/OpenHands-Cloud.

2. The OH_WEB_CLIENT_FEATURE_FLAGS_ENABLE_JIRA_DC gotcha

The Replicated overlay sets this env var automatically. Helm users have to set it themselves, and without it the backend routes are live but the Settings → Integrations card never renders. There is nothing in the current page for an operator to grep for when they hit this. Document the flag, where to set it, and the symptom.

3. Verification one-liner

A kubectl set env … --list (or kubectl exec env | grep JIRA_DC_) snippet showing the expected JIRA_DC_* env vars on the integrations pod for both linkMethod=oauth and linkMethod=email. Lets an operator confirm the secret actually propagated without reading chart source.

4. Reference deep-links into OpenHands-Cloud

Append a short Reference section linking to the canonical source-of-truth files for operators doing custom Helm overlays:

  • the Replicated config group definition
  • charts/openhands-secrets/templates/jira-dc-app.yaml
  • charts/openhands/templates/_env.yaml
  • the /integration/jira-dc/events ingress route
5. Troubleshooting recipes the current table doesn't have

Extend the existing 8-row symptom/check table (or add an accordion below it) with:

  • Email-match link "succeeds" but @openhands still asks the user to re-link — include a psql query against the user-link table to diagnose.
  • Rotating the service-account PAT or OAuth client secret — step-by-step procedure, including which pods need to restart.
  • Settings → Integrations card missing on a Helm install — cross-link to the ENABLE_JIRA_DC feature-flag note above.

Out of scope (intentionally)

  • Rewriting Alona's jira-data-center.mdx. All additions should be additive sections / tabs on the same page.
  • Bitbucket Data Center (separate page, same Helm-vs-Replicated story may apply later).
  • Air-gapped support (not currently supported per the page's prereqs).

Provenance

The deeper-dive material in closed PR #527 already covers items 1–5 above and can be lifted onto Alona's page as the implementation of this issue.

Related

  • #532 — added enterprise/integrations/jira-data-center.mdx (the Replicated guide this builds on)
  • #527 (closed) — the original deep-dive PR; superseded by #532, scoped down to this issue

This issue was filed by an AI agent (OpenHands) on behalf of @jpshackelford.

Dominant language
MDX
Stars
12
Forks
55
Avg merge
1d 11h
Merged PRs (30d)
36

Getting set up

We have not checked this project's setup files yet. Start from its README, and see our first-contribution guide for the general steps.

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.

More from OpenHands/docs

All issues in OpenHands/docs

Similar issues

More Databases issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.