only use root_domain variable for local dev

[eriktaubeneck]

I'm preparing to do some work on deployments, and I realized this variable doesn't actually make sense outside of local dev. When starting a helper, we should explicitly set the helper and sidecar domains.

This cleans that up.

Summary by CodeRabbit

• Documentation

  • Updated README with new command parameters and confirmation URL for starting the sidecar service.

• Chores

  • Removed --root_domain argument from Ansible configuration files (deploy.yaml and provision.yaml).
  • Removed root_domain=ipa-helper.dev declaration from ansible/inventory.ini.

• Refactor

  • Adjusted variable assignments in start_helper_sidecar.sh for domains, ports, and identity.

• Bug Fixes

  • Updated cli.py to require explicit helper_domain and sidecar_domain parameters, removing default assignments.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
draft	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 5, 2024 7:23pm

[coderabbitai]

Walkthrough

The recent updates focus on modifying domain configurations and ensuring explicit parameter requirements for starting a sidecar service. These changes impact various files, including deployment scripts (YAML), configuration files (INI), shell scripts, and Python CLI code. Notable adjustments include removing root domain defaults and enforcing explicit domain parameters to streamline and clarify functionality.

Changes

File	Change Summary
README.md	Updated to reflect new command parameters for starting a sidecar service and confirm URL changes.
ansible/deploy.yaml	Removed --root_domain argument from draft start-helper-sidecar command.
ansible/inventory.ini	Removed root_domain=ipa-helper.dev declaration under [myhosts:vars].
ansible/provision.yaml	Removed --root_domain argument from draft start-helper-sidecar command.
etc/start_helper_sidecar.sh	Reordered and assigned variables related to domains, ports, and identity correctly.
sidecar/cli/cli.py	Required explicit helper_domain and sidecar_domain parameters, removing default None values from CLI functions.

Poem

In the realm of code we tread,
Domains align, the script is fed,
No defaults, just clear, set lines,
Deployment sings, the system shines.
Helper, sidecar, ports in place,
Swiftly we launch, without a trace.
🌟🐇💻

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • Generate unit testing code for this file.
  • 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 generate unit testing code for this file.
  • @coderabbitai modularize this function.
• 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range and nitpick comments (1)

README.md (1)

71-74: Specify the language for the code block.

The fenced code block should have a language specified for better readability and syntax highlighting.

- ``` 
+ ```sh

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 17878b6 and 899785c.

Files selected for processing (6)

• README.md (1 hunks)
• ansible/deploy.yaml (1 hunks)
• ansible/inventory.ini (1 hunks)
• ansible/provision.yaml (1 hunks)
• etc/start_helper_sidecar.sh (1 hunks)
• sidecar/cli/cli.py (5 hunks)

Files skipped from review due to trivial changes (3)

• ansible/inventory.ini
• ansible/provision.yaml
• etc/start_helper_sidecar.sh

Additional context used

Markdownlint

README.md

70-70: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

Additional comments not posted (6)

ansible/deploy.yaml (1)

Line range hint 19-24:
LGTM! Ensure the new parameters are correctly passed.

The --root_domain argument has been removed, and the --helper_domain and --sidecar_domain arguments are now explicitly set. Ensure that these parameters are correctly passed and that the domains are properly configured in all environments.

README.md (1)

74-74: LGTM! Documentation updated correctly.

The documentation has been updated to reflect the new command parameters for starting the sidecar service.

sidecar/cli/cli.py (4)

80-81: LGTM! Parameters updated correctly.

The helper_domain and sidecar_domain parameters are now required for the start_traefik_command function. Ensure that these parameters are correctly passed in all function calls.

---

136-137: LGTM! Parameters updated correctly.

The helper_domain and sidecar_domain parameters are now required for the run_helper_sidecar function. Ensure that these parameters are correctly passed in all function calls.

---

176-177: LGTM! Parameters updated correctly.

The helper_domain and sidecar_domain parameters are now required for the start_helper_sidecar function. Ensure that these parameters are correctly passed in all function calls.

---

200-203: LGTM! Command updated correctly.

The command for starting the helper sidecar has been updated to include the helper_domain and sidecar_domain parameters.