Skip to content

feat: Add airgapped support to Plane-Enterprise configuration#148

Merged
twtaylor merged 4 commits intodevelopfrom
feat/helm-chart-for-airgapped
Aug 7, 2025
Merged

feat: Add airgapped support to Plane-Enterprise configuration#148
twtaylor merged 4 commits intodevelopfrom
feat/helm-chart-for-airgapped

Conversation

@twtaylor
Copy link
Contributor

@twtaylor twtaylor commented Aug 7, 2025

  • Introduced isAirgapped configuration option in values.yaml.
  • Updated app-env.yaml to include IS_AIRGAPPED environment variable.
  • Modified monitor.stateful.yaml to conditionally start the airgapped monitor command based on the new configuration.

Description

This adds airgapped support to our commercial release.

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Summary by CodeRabbit

  • New Features

    • Introduced an option to enable airgapped deployment mode via a new configuration setting.
    • When airgapped mode is enabled, specific environment variables and container commands are adjusted to reflect the airgapped state.
  • Chores

    • Added a new configuration flag for airgapped deployments in the configuration file.
    • Updated documentation to include the new airgapped configuration option.
    • Bumped the chart version to 1.3.3.

- Introduced `isAirgapped` configuration option in values.yaml.
- Updated app-env.yaml to include IS_AIRGAPPED environment variable.
- Modified monitor.stateful.yaml to conditionally start the airgapped monitor command based on the new configuration.
@twtaylor twtaylor requested a review from mguptahub August 7, 2025 05:14
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 7, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This change introduces a new airgapped.enabled boolean flag to the plane-enterprise Helm chart. Templates are conditionally updated to include an IS_AIRGAPPED environment variable in ConfigMaps and to modify the monitor StatefulSet container's command and arguments when airgapped mode is enabled. The chart version and documentation are also updated accordingly.

Changes

Cohort / File(s) Change Summary
Airgapped Configuration Flag
charts/plane-enterprise/values.yaml
Adds a new top-level airgapped.enabled boolean flag, defaulting to false.
App Environment ConfigMap Update
charts/plane-enterprise/templates/config-secrets/app-env.yaml
Adds conditional IS_AIRGAPPED environment variable set to "1" if airgapped mode is enabled.
Monitor ConfigMap Update
charts/plane-enterprise/templates/config-secrets/monitor.yaml
Adds conditional IS_AIRGAPPED environment variable set to "1" when airgapped mode is enabled.
Monitor StatefulSet Command Override
charts/plane-enterprise/templates/workloads/monitor.stateful.yaml
Conditionally sets container command to prime-monitor and argument to start-airgapped if airgapped mode is enabled, overriding default entrypoint.
Chart Metadata Update
charts/plane-enterprise/Chart.yaml
Updates chart version from 1.3.2 to 1.3.3.
Documentation Update
charts/plane-enterprise/README.md
Removes deprecated Docker registry config comments; adds documentation for airgapped.enabled flag under License section.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Helm
    participant Kubernetes
    participant Monitor Container

    User->>Helm: Deploy chart with airgapped.enabled=true
    Helm->>Kubernetes: Render templates with IS_AIRGAPPED=1 and modified monitor command
    Kubernetes->>Monitor Container: Start container with prime-monitor start-airgapped
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Suggested reviewers

  • sriramveeraghanta
  • mguptahub

Poem

A flag appears, a gentle sign,
Airgapped mode now in the line.
Secrets whisper, commands align,
Monitor starts in perfect time.
Bunny hops with joy anew,
Deployments fresh, configurations true!
🐰🌿✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6885b5f and 994ff8b.

📒 Files selected for processing (6)
  • charts/plane-enterprise/Chart.yaml (1 hunks)
  • charts/plane-enterprise/README.md (1 hunks)
  • charts/plane-enterprise/templates/config-secrets/app-env.yaml (1 hunks)
  • charts/plane-enterprise/templates/config-secrets/monitor.yaml (1 hunks)
  • charts/plane-enterprise/templates/workloads/monitor.stateful.yaml (1 hunks)
  • charts/plane-enterprise/values.yaml (1 hunks)
✨ Finishing Touches
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch feat/helm-chart-for-airgapped

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

- Set `isAirgapped.enabled` to false in values.yaml.
- Adjusted app-env.yaml and monitor.yaml to conditionally set IS_AIRGAPPED environment variable based on the updated configuration.
@twtaylor twtaylor marked this pull request as ready for review August 7, 2025 15:10
@twtaylor twtaylor requested a review from akshat5302 August 7, 2025 15:10
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (3)
charts/plane-enterprise/values.yaml (2)

13-15: Remove trailing whitespace flagged by YAMLlint

Line 13 has a stray space after isAirgapped: that fails the linter.

-isAirgapped: 
+isAirgapped:

13-15: Re-consider the extra enabled: nesting

Unless you expect additional air-gapped settings soon, a flat key (airgapped: false) keeps templates/readers simpler (.Values.airgapped vs .Values.isAirgapped.enabled).

charts/plane-enterprise/templates/config-secrets/monitor.yaml (1)

14-16: Add a terminating newline

YAMLlint reports “no new line character at end of file”. Append a blank line after {{- end }} to silence CI tools.

   IS_AIRGAPPED: "1"
   {{- end }}
+
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4740c2b and 6885b5f.

📒 Files selected for processing (4)
  • charts/plane-enterprise/templates/config-secrets/app-env.yaml (1 hunks)
  • charts/plane-enterprise/templates/config-secrets/monitor.yaml (1 hunks)
  • charts/plane-enterprise/templates/workloads/monitor.stateful.yaml (1 hunks)
  • charts/plane-enterprise/values.yaml (1 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
charts/plane-enterprise/values.yaml

[error] 13-13: trailing spaces

(trailing-spaces)

charts/plane-enterprise/templates/config-secrets/monitor.yaml

[error] 16-16: no new line character at the end of file

(new-line-at-end-of-file)

🔇 Additional comments (4)
charts/plane-enterprise/templates/config-secrets/monitor.yaml (1)

14-16: LGTM – conditional env var is applied cleanly

The templating pattern is concise and won’t emit empty keys when the feature is off.

charts/plane-enterprise/templates/config-secrets/app-env.yaml (1)

65-67: LGTM – environment flag mirrored for the app

Mirroring IS_AIRGAPPED here keeps application behaviour consistent with the monitor component.

charts/plane-enterprise/templates/workloads/monitor.stateful.yaml (2)

45-50: Confirm prime-monitor exists in the image

The command/args override is correct, but the container will CrashLoop if prime-monitor is missing or renamed in future tags. Please verify the binary is present for every version you publish.


45-50: LGTM – conditional override keeps default path untouched

The if block scopes the change to air-gapped deployments without affecting normal installs.

…ration references

- Updated version in Chart.yaml to 1.3.3.
- Changed references from `isAirgapped` to `airgapped` in values.yaml, app-env.yaml, monitor.yaml, and monitor.stateful.yaml.
- Adjusted README.md to reflect the new airgapped configuration option.
@twtaylor twtaylor requested a review from mguptahub August 7, 2025 15:23
@twtaylor twtaylor merged commit 3bc76b8 into develop Aug 7, 2025
2 of 3 checks passed
@twtaylor twtaylor deleted the feat/helm-chart-for-airgapped branch August 7, 2025 15:25
twtaylor added a commit that referenced this pull request Aug 7, 2025
feat: Add airgapped support to Plane-Enterprise configuration (#148)
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

Successfully merging this pull request may close these issues.

2 participants