Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

refs platform/3251: Update README.md to add new input variables for a… #6

Merged
merged 1 commit into from
Dec 9, 2024

Conversation

Stevesibilia
Copy link
Contributor

@Stevesibilia Stevesibilia commented Dec 9, 2024

User description

…dditional protected namespaces and statefulsets label selector


PR Type

Documentation, Enhancement


Description

  • Added documentation for new input variables:
    • additional_protected_namespaces: List of additional protected namespaces
    • cluster_role_binding_name: Name of the cluster role binding
    • statefulsets_label_selector: Label selector for Statefulsets scaling
    • managed_namespaces_all_label_selector: Label selector for all resources in managed namespaces
    • protected_namespaces: List of default protected namespaces
  • Updated descriptions to clarify working-hours scaling for deployments and statefulsets
  • Removed references to deprecated namespace-scoped resources
  • Improved documentation clarity and completeness for namespace management

Changes walkthrough 📝

Relevant files
Documentation
README.md
Update README with new input variables and resource management

README.md

  • Added new input variables documentation for protected namespaces and
    statefulsets
  • Updated description of deployments label selector
  • Added documentation for cluster role binding and namespace management
  • Removed outdated references to namespace-scoped resources
  • +6/-4     

    💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

    …dditional protected namespaces and statefulsets label selector
    @sparkfabrik-ai-bot
    Copy link

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Documentation Clarity
    The description for managed_namespaces_all_label_selector could be clearer about its relationship with managed_namespaces_label_selector and its specific purpose

    @sparkfabrik-ai-bot
    Copy link

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Score
    Enhancement
    Enhance documentation clarity by explaining the purpose of default protected namespaces

    Consider adding a brief description of the default protected namespaces and why they
    are protected by default to help users understand the security implications.

    README.md [36]

    -| <a name="input_protected_namespaces"></a> [protected\_namespaces](#input\_protected\_namespaces) | List of namespaces where the controller should not manage the scale of deployments. Use additional\_protected\_namespaces to add custom protected namespaces. | `list(string)` | <pre>[<br>  "kube-node-lease",<br>  "kube-public",<br>  "kube-system",<br>  "gmp-system",<br>  "gmp-public"<br>]</pre> | no |
    +| <a name="input_protected_namespaces"></a> [protected\_namespaces](#input\_protected\_namespaces) | List of system-critical namespaces (kube-system, kube-public, etc.) that are protected by default to prevent accidental scaling of essential cluster components. Use additional\_protected\_namespaces to add custom protected namespaces. | `list(string)` | <pre>[<br>  "kube-node-lease",<br>  "kube-public",<br>  "kube-system",<br>  "gmp-system",<br>  "gmp-public"<br>]</pre> | no |
    Suggestion importance[1-10]: 5

    Why: The suggestion improves documentation clarity by providing context about system-critical namespaces, which helps users understand the security implications. However, it's a minor documentation enhancement that doesn't affect functionality.

    5

    @Stevesibilia Stevesibilia merged commit 5557d76 into main Dec 9, 2024
    1 check passed
    @Stevesibilia Stevesibilia deleted the 3251_fix_readme branch December 9, 2024 13:49
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    1 participant