coderabbitai[bot]
commented
5 months ago Walkthrough
The recent updates introduce a new configuration option, skip_secrets_setup, across various files to allow skipping the secrets setup when running the cpl setup-app command. This involves modifications to documentation, configuration files, and the core logic of the application. The changes also include renaming the --skip-secret-access-binding option to --skip-secrets-setup, automatically creating identities if they do not exist, and enhancing the handling of secrets and policies.
Changes
| File(s) | Change Summary |
|---|---|
README.md, docs/commands.md, docs/secrets-and-env-values.md, docs/tips.md |
Updated documentation to reflect the new skip_secrets_setup option and provide detailed instructions on secrets management. |
examples/controlplane.yml |
Introduced the skip_secrets_setup option in the aliases section, allowing users to skip secrets setup. |
lib/command/apply_template.rb, lib/command/base.rb, lib/command/setup_app.rb |
Added and updated options and methods to handle skip_secrets_setup and related identity and policy creation logic. |
lib/core/helpers.rb, lib/cpl.rb |
Enhanced helper methods to normalize command and option names, and handle deprecated options. |
spec/command/delete_spec.rb, spec/command/setup_app_spec.rb, spec/support/command_helpers.rb |
Updated test cases to reflect the renaming of the option from --skip-secret-access-binding to --skip-secrets-setup and added tests for deprecated options. |
CHANGELOG.md |
Documented the new --skip-secrets-setup option and the deprecation of --skip-secret-access-binding. |
Sequence Diagram(s) (Beta)
sequenceDiagram
participant User
participant CLI
participant Config
participant SecretsManager
participant IdentityManager
User->>CLI: Run `cpl setup-app`
CLI->>Config: Load configuration
Config-->>CLI: Provide configuration
CLI->>CLI: Check `skip_secrets_setup` option
alt skip_secrets_setup is true
CLI->>SecretsManager: Skip secrets setup
else
CLI->>IdentityManager: Create identity if not exists
CLI->>SecretsManager: Setup secrets and policies
end
CLI-->>User: Setup completeAssessment against linked issues
| Objective | Addressed | Explanation |
|---|---|---|
| Docs on secrets (#186) | ✅ | |
| Automatically create identity if not existing and remove from app.yml (#187) | ✅ | |
| Rename --skip-secret-access-binding to --skip-secrets-setup (#189) | ✅ |
Poem
In the land of code where secrets hide,
A rabbit hops with joy and pride,
Skipping setups when told to do,
Making life easier for me and you.
With identities crafted on the fly,
Our app soars high into the sky.
🐇✨
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?
Fixes #186 Fixes #187 Fixes #189
To simplify the process of setting up secrets, the identity is now automatically created in the
setup-appcommand if it's not in theapptemplate.Also:
--skip-secret-access-bindingoption in favor of--skip-secrets-setupskip_secrets_setupoption to the.controlplane/controlplane.ymlfile.Finally, moved the "ENV Values" section from
tips.mdto a separatesecrets-and-env-values.mdfile, and added an explanation of the relationship between secrets, secrets policy, and identity.Summary by CodeRabbit
New Features
skip_secrets_setupto skip secrets setup when runningcpl setup-app.Documentation
secrets-and-env-values.md.commands.mdandtips.mdto reflect changes related to secrets setup.--skip-secret-access-bindingin favor of--skip-secrets-setup.Bug Fixes
setup-appcommand correctly handles secret, policy, and identity creation based on new configuration options.Refactor
skip_secrets_setupfunctionality.