Kuadrant / multicluster-gateway-controller

multi-cluster gateway controller, manages multi-cluster gateways based on gateway api and policy attachment
Apache License 2.0
10 stars 23 forks source link

Remove unnecessary dependencies and align local setup and quickstart scripts #789

Closed mikenairn closed 4 months ago

mikenairn commented 5 months ago

refactor: remove unnecessary dependencies

refactor: Align local-setup and quick-start deployment paths

Updates local-setup to use the same kustomizations as the quick start scripts. Installation and configuration of hub and spoke dependencies is now consistent across both deployment paths.

The only difference between quick start and local setup now is that metrics is enabled by default with local-setup, managedzones and dns providers are created using local environment files instead of environment variables and the MGC gateway controller is not running on the hub cluster.

Note: The skupper POC docs are listed in our docs site and would need to be removed before the next release if we merge this as is. Personally i see no advantage to leaving these here.

gitguardian[bot] commented 5 months ago

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request
| GitGuardian id | GitGuardian status | Secret | Commit | Filename | | | -------------- | ------------------ | ------------------------------ | ---------------- | --------------- | -------------------- | | [-](https://dashboard.gitguardian.com/incidents/secrets) | | Generic Private Key | 9b77983908fa56e376421e4990f13441798d1155 | config/webhook-setup/control/tls/tls.key | [View secret](https://github.com/Kuadrant/multicluster-gateway-controller/commit/9b77983908fa56e376421e4990f13441798d1155#diff-a808078e53fdc668d5b5107ffeb895bed8e21f75fd200b6f4d6a328ec22cf6edR1) |
🛠 Guidelines to remediate hardcoded secrets
1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secret safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate this secret](https://docs.gitguardian.com/secrets-detection/secrets-detection-engine/detectors/specifics/private_key_generic#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!

maleck13 commented 5 months ago

I think it is reasonable to remove the skupper and submariner docs at this point. We don't ever test them and really if you use gateway API and use an e/w technology that either support multi-cluster service or a regular service we will be able to work with it. Changes look fine.

Will run a local-setup to verify

maleck13 commented 4 months ago

local setup completed so happy to merge /lgtm

openshift-ci[bot] commented 4 months ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: maleck13, mikenairn

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/Kuadrant/multicluster-gateway-controller/blob/main/OWNERS)~~ [maleck13,mikenairn] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment