Skip to content

📖 Document environment variables for configuring the extension - #1466

Merged
djzager merged 1 commit into
konveyor:mainfrom
djzager:docs/document-env-variables
Jul 13, 2026
Merged

📖 Document environment variables for configuring the extension#1466
djzager merged 1 commit into
konveyor:mainfrom
djzager:docs/document-env-variables

Conversation

@djzager

@djzager djzager commented Jun 29, 2026

Copy link
Copy Markdown
Member

Problem

The extension supports environment variables for pre-configuring behavior in managed environments like Dev Spaces, but they are not documented anywhere. Users have to grep source code to discover them.

Solution

Added an Environment Variables section to the extension README (vscode/core/README.md) documenting all supported env vars organized into four categories:

  • Hub ConfigurationHUB_URL, HUB_USERNAME, HUB_PASSWORD, FORCE_HUB_ENABLED, HUB_INSECURE, HUB_SOLUTION_SERVER_ENABLED, HUB_PROFILE_SYNC_ENABLED
  • Analyzer Binary DownloadANALYZER_FALLBACK_BASE_URL
  • TLS and CertificatesCA_BUNDLE, AWS_CA_BUNDLE, ALLOW_INSECURE, NODE_TLS_REJECT_UNAUTHORIZED
  • ProxyHTTPS_PROXY/https_proxy, HTTP_PROXY/http_proxy, NO_PROXY/no_proxy

Each variable includes its type, default value, description, and relevant behavioral notes (e.g., precedence over VS Code settings, automatic Hub enablement).

Closes #1462

@djzager
djzager requested a review from a team as a code owner June 29, 2026 18:29
@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

@djzager, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 39 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: c4f72e71-7308-4816-9de6-822a40c6b68b

📥 Commits

Reviewing files that changed from the base of the PR and between 9ef1343 and f01526c.

📒 Files selected for processing (2)
  • changes/unreleased/document-environment-variables.yaml
  • vscode/core/README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@savitharaghunathan savitharaghunathan changed the title 📝 Document environment variables for configuring the extension 📖 Document environment variables for configuring the extension Jun 29, 2026
@djzager djzager added the cherry-pick/release-0.6 Cherry-pick to the release-0.6 branch label Jul 6, 2026
@djzager
djzager force-pushed the docs/document-env-variables branch from 95cc07d to c10cd86 Compare July 6, 2026 13:10
Add an Environment Variables section to the extension README documenting
all supported env vars for pre-configuring the extension in managed
environments like Dev Spaces.

Covers:
- Hub configuration (HUB_URL, HUB_USERNAME, HUB_PASSWORD, etc.)
- Analyzer binary download (ANALYZER_FALLBACK_BASE_URL)
- TLS and certificates (CA_BUNDLE, ALLOW_INSECURE, etc.)
- Proxy settings (HTTPS_PROXY, HTTP_PROXY, NO_PROXY, etc.)

Closes konveyor#1462

Signed-off-by: David Zager <david.j.zager@gmail.com>
@djzager
djzager force-pushed the docs/document-env-variables branch from c10cd86 to f01526c Compare July 13, 2026 16:26
@djzager
djzager merged commit 03b48e1 into konveyor:main Jul 13, 2026
19 of 20 checks passed
@konveyor-ci-bot

Copy link
Copy Markdown

PR cherry-picked to branch release-0.6. Backport PR: #1475

djzager added a commit that referenced this pull request Jul 14, 2026
#1475)

## Problem

The extension supports environment variables for pre-configuring
behavior in managed environments like Dev Spaces, but they are not
documented anywhere. Users have to grep source code to discover them.

## Solution

Added an **Environment Variables** section to the extension README
(`vscode/core/README.md`) documenting all supported env vars organized
into four categories:

- **Hub Configuration** — `HUB_URL`, `HUB_USERNAME`, `HUB_PASSWORD`,
`FORCE_HUB_ENABLED`, `HUB_INSECURE`, `HUB_SOLUTION_SERVER_ENABLED`,
`HUB_PROFILE_SYNC_ENABLED`
- **Analyzer Binary Download** — `ANALYZER_FALLBACK_BASE_URL`
- **TLS and Certificates** — `CA_BUNDLE`, `AWS_CA_BUNDLE`,
`ALLOW_INSECURE`, `NODE_TLS_REJECT_UNAUTHORIZED`
- **Proxy** — `HTTPS_PROXY`/`https_proxy`, `HTTP_PROXY`/`http_proxy`,
`NO_PROXY`/`no_proxy`

Each variable includes its type, default value, description, and
relevant behavioral notes (e.g., precedence over VS Code settings,
automatic Hub enablement).

Closes #1462

Signed-off-by: David Zager <david.j.zager@gmail.com>
Signed-off-by: Cherry Picker <noreply@github.com>

Signed-off-by: David Zager <david.j.zager@gmail.com>
Signed-off-by: Cherry Picker <noreply@github.com>
Co-authored-by: David Zager <dzager@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cherry-pick/release-0.6 Cherry-pick to the release-0.6 branch

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document environment variables for configuring the extension

2 participants