From 50d9cad05b961f2a3675263ff22a06f91a767175 Mon Sep 17 00:00:00 2001 From: Samuel Torres <84316763+samuel-form3@users.noreply.github.com> Date: Fri, 20 Dec 2024 12:56:58 +0000 Subject: [PATCH] feat: Improve documentation (#8) feat: Improve documentation Signed-off-by: Samuel Torres --- .github/workflows/test.yaml | 4 - LICENSE | 201 ++++++++++++++++++ Makefile | 14 +- README.md | 24 +-- docs/Makefile | 2 +- docs/mkdocs.yml | 26 ++- docs/src/code-of-conduct.md | 133 ++++++++++++ docs/src/configuring-disruption-probes.md | 28 ++- docs/src/developer-guide.md | 110 ++++++++++ docs/src/release.md | 11 + hack/common.sh | 38 +--- hack/env/metallb.yaml | 4 +- hack/install-metallb.sh | 16 +- hack/install-xpdb.sh | 2 +- .../disruptionprobe/v1/disruptionprobe.pb.go | 26 ++- .../v1/disruptionprobe_grpc.pb.go | 6 +- .../disruptionprobe/v1/disruptionprobe.proto | 17 +- 17 files changed, 571 insertions(+), 91 deletions(-) create mode 100644 LICENSE create mode 100644 docs/src/code-of-conduct.md create mode 100644 docs/src/developer-guide.md create mode 100644 docs/src/release.md diff --git a/.github/workflows/test.yaml b/.github/workflows/test.yaml index 04b2082..cd484f8 100644 --- a/.github/workflows/test.yaml +++ b/.github/workflows/test.yaml @@ -26,18 +26,14 @@ jobs: go-version-file: go.mod - uses: bufbuild/buf-action@v1 name: Buf check proto - id: run-check-proto with: breaking: false pr_comment: false - name: Lint - id: run-lint run: make lint - name: Helm Lint - id: helm-lint run: make helm-lint - name: Run Go tests - id: run-tests run: make test - name: Run E2E tests id: run-e2e-tests diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..261eeb9 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/Makefile b/Makefile index c56a118..b249a30 100644 --- a/Makefile +++ b/Makefile @@ -224,12 +224,20 @@ install: kind-load ## Installs x-pdb into a cluster .PHONY: proto-generate proto-generate: ## Generates the go packages from the proto contracts. - buf generate + @buf generate .PHONY: proto-lint proto-lint: ## Lints the proto contracts - buf lint - + @buf lint + +.PHONY: proto-fmt +proto-fmt: ## Formats the proto contracts + @buf format -w + +.PHONY: proto-breaking +proto-breaking: ## Verifies if there are beaking changes in the proto contracts + @buf breaking --against 'https://github.com/form3tech-oss/x-pdb.git' + ##@ Dependencies ## Location to install dependencies to diff --git a/README.md b/README.md index 0e3aaf9..01531ac 100644 --- a/README.md +++ b/README.md @@ -5,24 +5,22 @@ X-PDB allows you to define multi-cluster PodDisruptionBudgets and blocks evictio This allows you to operate stateful workloads spanning multiple clusters and limit disruptions to a necessary minimum. This is needed, because each cluster acts individually (evictions, rolling out updates etc) which may cause service disruptions simultaneously across clusters. -Please refer to the documentation at https://form3tech-oss.github.io/x-pdb +## ๐Ÿ“™Documentation -## Development +X-PDB installation and reference documents are available at https://form3tech-oss.github.io/x-pdb. -### Running tests +๐Ÿ‘‰ [Overview](https://form3tech-oss.github.io/x-pdb) -Simple tests can be ran with `make test`. +๐Ÿ‘‰ [Getting Started](https://form3tech-oss.github.io/x-pdb/getting-started) -Integration tests can be ran with the following commands. -This will create three `kind` clusters which are connected through `metallb`. +๐Ÿ‘‰ [Configure X-PDB Resources](https://form3tech-oss.github.io/x-pdb/configuring-xpdb) -``` -make multi-cluster -make deploy-e2e -make e2e -``` +## Contributing -The e2e tests deploy a test pod which allows us to control their readiness probe, see `cmd/testapp` for details. +๐Ÿ‘‰ [Developer Guide](https://form3tech-oss.github.io/x-pdb/developer-guide) -When developing `x-pdb` e2e tests you need to re-build and deploy the Pod using `make deploy`. +๐Ÿ‘‰ [Code of Conduct](https://form3tech-oss.github.io/x-pdb/code-of-conduct) +## License + +X-PDB is licensed under the [Apache License 2.0](./LICENSE). diff --git a/docs/Makefile b/docs/Makefile index 78676c8..d6056e6 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -20,4 +20,4 @@ live-docs: build-image ## Build and launch a local copy of the documentation web -v ${PWD}:/docs \ --entrypoint /bin/bash \ xpdb-docs \ - -c "pip install -r /docs/requirements.txt && mkdocs serve --dev-addr=0.0.0.0:8000" + -c "pip install -r /docs/requirements.txt && mkdocs serve --watch-theme --dev-addr=0.0.0.0:8000" diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index c7c9c8e..12340e0 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -52,10 +52,22 @@ theme: - navigation.sections palette: - primary: "deep orange" - accent: "indigo" + primary: custom - include_sidebar: true + palette: + # Palette toggle for light mode + - scheme: default + primary: teal + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + primary: teal + toggle: + icon: material/brightness-4 + name: Switch to light mode plugins: - search @@ -67,9 +79,13 @@ nav: - Introduction: - Overview: "index.md" - Getting Started: "getting-started.md" - - Configuring x-pdb: + - Configuring X-PDB: - XPodDisruptionBudget: "configuring-xpdb.md" - Disruption Probes: "configuring-disruption-probes.md" - - Operating x-pdb: + - Operating X-PDB: - Failure Scenarios: "failure-scenarios.md" - Metrics & SLOs: "metrics-slos.md" + - Contributing: + - Developer Guide: "developer-guide.md" + - Release Process: "release.md" + - Code of Conduct: "code-of-conduct.md" diff --git a/docs/src/code-of-conduct.md b/docs/src/code-of-conduct.md new file mode 100644 index 0000000..20bcc4f --- /dev/null +++ b/docs/src/code-of-conduct.md @@ -0,0 +1,133 @@ + +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, caste, color, religion, or sexual +identity and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the overall + community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or advances of + any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email address, + without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official email address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +[INSERT CONTACT METHOD]. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series of +actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or permanent +ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within the +community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.1, available at +[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. + +Community Impact Guidelines were inspired by +[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. + +For answers to common questions about this code of conduct, see the FAQ at +[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at +[https://www.contributor-covenant.org/translations][translations]. + +[homepage]: https://www.contributor-covenant.org +[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html +[Mozilla CoC]: https://github.com/mozilla/diversity +[FAQ]: https://www.contributor-covenant.org/faq +[translations]: https://www.contributor-covenant.org/translations diff --git a/docs/src/configuring-disruption-probes.md b/docs/src/configuring-disruption-probes.md index 6ae8626..bac5775 100644 --- a/docs/src/configuring-disruption-probes.md +++ b/docs/src/configuring-disruption-probes.md @@ -23,13 +23,13 @@ Example use-cases: apiVersion: x-pdb.form3.tech/v1alpha1 kind: XPodDisruptionBudget metadata: - name: kube-dns - namespace: kube-system + name: opensearch + namespace: opensearch spec: minAvailable: 80% selector: matchLabels: - k8s-app: kube-dns + k8s-app: opensearch probe: endpoint: opensearch-disruption-probe.opensearch.svc.cluster.local:8080 ``` @@ -43,24 +43,36 @@ At this point, the communication between x-pdb and the probe server does not use The DisruptionProbe server allows the client to ask if a disruption for a given pod and XPDB resource is allowed. ```proto -service DisruptionProbe { - // Sends a IsDisruptionAllowed request +// The DisruptionProbe service definition. +service DisruptionProbeService { + // Sends a IsDisruptionAllowed request which will check if a given Pod + // can be disrupted according to some specific rules. rpc IsDisruptionAllowed(IsDisruptionAllowedRequest) returns (IsDisruptionAllowedResponse) {} } -// The request message containing the user's name. +// IsDisruptionAllowedRequest has the information to request a check for disruption. message IsDisruptionAllowedRequest { + // The name of the pod that is being disrupted. string pod_name = 1; + + // The namespaces of the pod that is being disrupted. string pod_namespace = 2; + + // The name of the XPodDisruptionBudget resource that was protecting the pod. string xpdb_name = 3; + + // The namespace of the XPodDisruptionBudget resource that was protecting the pod. string xpdb_namespace = 4; } -// The response message containing the greetings +// IsDisruptionAllowedRespobse has the information on wether a disruption is allowed or not. message IsDisruptionAllowedResponse { + // Information on wether disruption is allowed. bool is_allowed = 1; + + // Error information on why a disruption is not allowed. string error = 2; } - ``` +You can check for a sample implementation on `cmd/testdisruptionprobe/main.go`. diff --git a/docs/src/developer-guide.md b/docs/src/developer-guide.md new file mode 100644 index 0000000..5c03039 --- /dev/null +++ b/docs/src/developer-guide.md @@ -0,0 +1,110 @@ +# Developer Guide + +## Getting Started + +You must have a working [Go environment](https://golang.org/doc/install) and +then clone the repo: + +```shell +git clone https://github.com/form3tech-oss/x-pdb.git +cd x-pdb +``` + +You'll need the following tools to work with the project: + +- [Kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) +- [Kind](https://kind.sigs.k8s.io/docs/user/quick-start/#installation) +- [Helm](https://helm.sh/docs/intro/install/) +- [Kubebuilder](https://book.kubebuilder.io/quick-start.html#installation) +- [Buf](https://buf.build/docs/installation/) + +## Build and Test + +The project uses the `make` build system. It'll run code generators, tests and static code analysis. + +### Development environment + +The development environment is based of 3 kind clusters that are connected together through some loadbalancers using MetalLB. + +X-PDB on each cluster will expose a LoadBalancer service which the IP is going to be provisioned by MetalLB. That IP is going to be available to all the clusters, allowing X-PDB to talk with other X-PDB services in other clusters. + +To spin up the development environment you should run the following command: + +```bash +make multi-cluster +``` + +You should run the following command to install x-pdb on all the 3 kind clusters: + +```bash +make deploy +``` + +After it is installed you are able to create workloads and x-pdb resources to test out the features. + +### Testing + +#### Unit tests + +X-PDB unit tests can be run with the following command: + +```bash +make test +``` + +#### E2E Tests + +E2E test suite will need the development environment to be up and running. +You will need to build and deploy some testing applications by running the following command. + +```bash +make deploy-e2e +``` + +After the testing applications are installed you can run the E2E test suite by running the following command: + +```bash +make e2e +``` + +### Linting + +Before commiting your changes ensure that codebase is linted. + +```bash +make fmt +make proto-format +make lint +make helm-lint +make proto-lint +``` + +### Working with gPRC + +The gPRC protobuf contracts are declared in: + +- `proto/disruptionprobe/v1/disruptionprobe.proto` +- `proto/state/v1/state.proto` + +These contracts are managed by [buf](https://buf.build/docs/cli/). +It will allow us to easily manage everything related with gRPC. + +After you make changes to proto contracts please run the following commands to ensure all changes valid: + +```bash +make proto-format +make proto-lint +make proto-breaking +make proto-generate +``` + +## Documentation + +Documentation for this project is done by [mkdocs](https://www.mkdocs.org/). + +To test out the changes while you're changing documentation run the following command: + +```bash +cd docs +make live-docs +``` diff --git a/docs/src/release.md b/docs/src/release.md new file mode 100644 index 0000000..513a12b --- /dev/null +++ b/docs/src/release.md @@ -0,0 +1,11 @@ +# Release Process + +X-PDB release process is performed by the `Create Release` GHA Workflow. + +The workflow needs the version of the release, from which branch it will be generated and if it will be a pre-release. + +This process will perform the following actions: + +1. Build and Publish X-PDB Docker images into GHCR. +2. Package and Publish the HelmChart into GHCR and Github Pages. +3. Create a Github Release with the changelog since the last release. diff --git a/hack/common.sh b/hack/common.sh index 7d4046a..14b6fdb 100644 --- a/hack/common.sh +++ b/hack/common.sh @@ -1,34 +1,18 @@ #!/bin/bash -function docker_bridge_cidr() { - docker network inspect -f json kind | jq -r '.[0].IPAM.Config[] | select(.Subnet | contains(":") | not) | .Subnet' +function docker_bridge_base_cidr() { + local DOCKER_CIDR=$(docker network inspect -f json kind | jq -r '.[0].IPAM.Config[] | select(.Subnet | contains(":") | not) | .Subnet') + echo $DOCKER_CIDR | cut -d'.' -f1-2 } -function metallb_cidr() { - CLUSTER_ID="${1}" - NET_NUM=$((1024 - $CLUSTER_ID)) - BRIDGE_CIDR=$(docker_bridge_cidr "${CLUSTER_ID}") - echo "cidrsubnet(\"$BRIDGE_CIDR\", 10, $NET_NUM)" | terraform console | sed 's/"//g' +function metallb_address_cidr() { + local CLUSTER_ID=$1 + local DOCKER_BASE_CIDR=$(docker_bridge_base_cidr) + echo "$DOCKER_BASE_CIDR.$((250+$CLUSTER_ID)).250/28" } -function host_min() { - CIDR="${1}" - echo "cidrhost(\"$CIDR\", 1)" | terraform console | sed 's/"//g' -} - -function host_max() { - CIDR="${1}" - echo "cidrhost(\"$CIDR\", -2)" | terraform console | sed 's/"//g' -} - -function metallb_host_min() { - CLUSTER_ID="${1}" - METALLB_CIDR=$(metallb_cidr "${CLUSTER_ID}") - host_min "$METALLB_CIDR" -} - -function metallb_host_max() { - CLUSTER_ID="${1}" - METALLB_CIDR=$(metallb_cidr "${CLUSTER_ID}") - host_max "$METALLB_CIDR" +function x_pdb_address() { + local CLUSTER_ID=$1 + local DOCKER_BASE_CIDR=$(docker_bridge_base_cidr) + echo "$DOCKER_BASE_CIDR.$((250+$CLUSTER_ID)).251" } diff --git a/hack/env/metallb.yaml b/hack/env/metallb.yaml index 2b3dd4c..fef9aab 100644 --- a/hack/env/metallb.yaml +++ b/hack/env/metallb.yaml @@ -5,10 +5,10 @@ metadata: namespace: metallb-system spec: addresses: - - ${METALLB_HOST_MIN}-${METALLB_HOST_MAX} + - ${METALLB_ADDRESS_CIDR} --- apiVersion: metallb.io/v1beta1 kind: L2Advertisement metadata: name: empty - namespace: metallb-system \ No newline at end of file + namespace: metallb-system diff --git a/hack/install-metallb.sh b/hack/install-metallb.sh index 97a0023..012b2b7 100755 --- a/hack/install-metallb.sh +++ b/hack/install-metallb.sh @@ -2,21 +2,13 @@ set -e set -o pipefail -CONTEXT="${1}" -CLUSTER="${2}" +CONTEXT=$1 +CLUSTER=$2 source ./hack/common.sh -# We expect a x.x.x.x/16 on the docker network bridge, -# and we need to have a /26 of that and assign it to metallb. -# Because we need non-overlapping ip ranges on metallb we use the cluster number (1, 2, 3) -# to calculate the last /26 subnets of that /16 range. -# cluster=1 gets the last /26 -# cluster=2 gets the second to last /26 -# etc. etc. -export METALLB_HOST_MIN=$(metallb_host_min "$CLUSTER") -export METALLB_HOST_MAX=$(metallb_host_max "$CLUSTER") -echo "using metallb range $METALLB_HOST_MIN-$METALLB_HOST_MAX" +export METALLB_ADDRESS_CIDR=$(metallb_address_cidr $CLUSTER) +echo "Using MetalLB Address ${METALLB_ADDRESS_CIDR}" kubectl apply --wait=true -f ./hack/env/metallb-native.yaml --context "${CONTEXT}" kubectl wait deployment -n metallb-system controller --for condition=Available=True --timeout=90s --context "${CONTEXT}" diff --git a/hack/install-xpdb.sh b/hack/install-xpdb.sh index 04a0156..0c1b265 100755 --- a/hack/install-xpdb.sh +++ b/hack/install-xpdb.sh @@ -13,7 +13,7 @@ source ./hack/common.sh this_address="" remote_endpoints="" for i in 1 2 3; do - METALLB_HOST_MIN=$(metallb_host_min $i) + METALLB_HOST_MIN=$(x_pdb_address $i) if [[ "$i" -eq "$CLUSTER" ]]; then this_address="$METALLB_HOST_MIN" continue diff --git a/pkg/proto/disruptionprobe/v1/disruptionprobe.pb.go b/pkg/proto/disruptionprobe/v1/disruptionprobe.pb.go index b4c43e3..f25fe05 100644 --- a/pkg/proto/disruptionprobe/v1/disruptionprobe.pb.go +++ b/pkg/proto/disruptionprobe/v1/disruptionprobe.pb.go @@ -20,13 +20,17 @@ const ( _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) ) -// The request message containing the user's name. +// IsDisruptionAllowedRequest has the information to request a check for disruption. type IsDisruptionAllowedRequest struct { - state protoimpl.MessageState `protogen:"open.v1"` - PodName string `protobuf:"bytes,1,opt,name=pod_name,json=podName,proto3" json:"pod_name,omitempty"` - PodNamespace string `protobuf:"bytes,2,opt,name=pod_namespace,json=podNamespace,proto3" json:"pod_namespace,omitempty"` - XpdbName string `protobuf:"bytes,3,opt,name=xpdb_name,json=xpdbName,proto3" json:"xpdb_name,omitempty"` - XpdbNamespace string `protobuf:"bytes,4,opt,name=xpdb_namespace,json=xpdbNamespace,proto3" json:"xpdb_namespace,omitempty"` + state protoimpl.MessageState `protogen:"open.v1"` + // The name of the pod that is being disrupted. + PodName string `protobuf:"bytes,1,opt,name=pod_name,json=podName,proto3" json:"pod_name,omitempty"` + // The namespaces of the pod that is being disrupted. + PodNamespace string `protobuf:"bytes,2,opt,name=pod_namespace,json=podNamespace,proto3" json:"pod_namespace,omitempty"` + // The name of the XPodDisruptionBudget resource that was protecting the pod. + XpdbName string `protobuf:"bytes,3,opt,name=xpdb_name,json=xpdbName,proto3" json:"xpdb_name,omitempty"` + // The namespace of the XPodDisruptionBudget resource that was protecting the pod. + XpdbNamespace string `protobuf:"bytes,4,opt,name=xpdb_namespace,json=xpdbNamespace,proto3" json:"xpdb_namespace,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache } @@ -89,11 +93,13 @@ func (x *IsDisruptionAllowedRequest) GetXpdbNamespace() string { return "" } -// The response message containing the greetings +// IsDisruptionAllowedRespobse has the information on wether a disruption is allowed or not. type IsDisruptionAllowedResponse struct { - state protoimpl.MessageState `protogen:"open.v1"` - IsAllowed bool `protobuf:"varint,1,opt,name=is_allowed,json=isAllowed,proto3" json:"is_allowed,omitempty"` - Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` + state protoimpl.MessageState `protogen:"open.v1"` + // Information on wether disruption is allowed. + IsAllowed bool `protobuf:"varint,1,opt,name=is_allowed,json=isAllowed,proto3" json:"is_allowed,omitempty"` + // Error information on why a disruption is not allowed. + Error string `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"` unknownFields protoimpl.UnknownFields sizeCache protoimpl.SizeCache } diff --git a/pkg/proto/disruptionprobe/v1/disruptionprobe_grpc.pb.go b/pkg/proto/disruptionprobe/v1/disruptionprobe_grpc.pb.go index 5ebccd3..868b169 100644 --- a/pkg/proto/disruptionprobe/v1/disruptionprobe_grpc.pb.go +++ b/pkg/proto/disruptionprobe/v1/disruptionprobe_grpc.pb.go @@ -28,7 +28,8 @@ const ( // // The DisruptionProbe service definition. type DisruptionProbeServiceClient interface { - // Sends a IsDisruptionAllowed request + // Sends a IsDisruptionAllowed request which will check if a given Pod + // can be disrupted according to some specific rules. IsDisruptionAllowed(ctx context.Context, in *IsDisruptionAllowedRequest, opts ...grpc.CallOption) (*IsDisruptionAllowedResponse, error) } @@ -56,7 +57,8 @@ func (c *disruptionProbeServiceClient) IsDisruptionAllowed(ctx context.Context, // // The DisruptionProbe service definition. type DisruptionProbeServiceServer interface { - // Sends a IsDisruptionAllowed request + // Sends a IsDisruptionAllowed request which will check if a given Pod + // can be disrupted according to some specific rules. IsDisruptionAllowed(context.Context, *IsDisruptionAllowedRequest) (*IsDisruptionAllowedResponse, error) mustEmbedUnimplementedDisruptionProbeServiceServer() } diff --git a/proto/disruptionprobe/v1/disruptionprobe.proto b/proto/disruptionprobe/v1/disruptionprobe.proto index 9a97f62..1d59c16 100644 --- a/proto/disruptionprobe/v1/disruptionprobe.proto +++ b/proto/disruptionprobe/v1/disruptionprobe.proto @@ -6,20 +6,31 @@ option go_package = "github.com/x-pdb/pkg/protos/disruptionprobe"; // The DisruptionProbe service definition. service DisruptionProbeService { - // Sends a IsDisruptionAllowed request + // Sends a IsDisruptionAllowed request which will check if a given Pod + // can be disrupted according to some specific rules. rpc IsDisruptionAllowed(IsDisruptionAllowedRequest) returns (IsDisruptionAllowedResponse) {} } -// The request message containing the user's name. +// IsDisruptionAllowedRequest has the information to request a check for disruption. message IsDisruptionAllowedRequest { + // The name of the pod that is being disrupted. string pod_name = 1; + + // The namespaces of the pod that is being disrupted. string pod_namespace = 2; + + // The name of the XPodDisruptionBudget resource that was protecting the pod. string xpdb_name = 3; + + // The namespace of the XPodDisruptionBudget resource that was protecting the pod. string xpdb_namespace = 4; } -// The response message containing the greetings +// IsDisruptionAllowedRespobse has the information on wether a disruption is allowed or not. message IsDisruptionAllowedResponse { + // Information on wether disruption is allowed. bool is_allowed = 1; + + // Error information on why a disruption is not allowed. string error = 2; }