diff --git a/.github/.kodiak.toml b/.github/.kodiak.toml new file mode 100644 index 0000000..ded81e4 --- /dev/null +++ b/.github/.kodiak.toml @@ -0,0 +1,18 @@ +version = 1 + +[merge] +method = "squash" # default: "merge" +delete_branch_on_merge = true # default: false +optimistic_updates = true # default: true +prioritize_ready_to_merge = true # default: false + +[merge.message] +title = "pull_request_title" # default: "github_default" +body = "github_default" # default: "github_default" +strip_html_comments = true # default: false + +[update] +always = true # default: false + +[approve] +auto_approve_usernames = ["1gtm", "tamalsaha"] diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..04579ac --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,60 @@ +name: CI + +on: + pull_request: + branches: + - "*" + push: + branches: + - master + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} + cancel-in-progress: true + +jobs: + build: + name: Build + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + + - name: Install link checker + run: | + curl -fsSL -o liche https://github.com/appscodelabs/liche/releases/download/v0.1.0/liche-linux-amd64 + chmod +x liche + sudo mv liche /usr/local/bin/liche + + - name: Install codespan schema checker + run: | + curl -fsSL -o codespan-schema-checker https://github.com/kmodules/codespan-schema-checker/releases/latest/download/codespan-schema-checker-linux-amd64 + chmod +x codespan-schema-checker + sudo mv codespan-schema-checker /usr/local/bin/codespan-schema-checker + + - name: Check links + run: | + liche -r docs -d $(pwd) -c 10 -p -h -l -x '^(.*/docs/{{<.*>}}/.*|.*github.com.*|.*api.slack.com.*|.*askapache.com.*|.*twitter.com.*|.*dev.mysql.com.*|.*linux.die.net.*)$' + + - name: Create Kubernetes cluster + id: kind + uses: engineerd/setup-kind@v0.5.0 + with: + version: v0.29.0 + + - name: Prepare cluster for testing + id: local-path + run: | + echo "waiting for nodes to be ready ..." + kubectl wait --for=condition=Ready nodes --all --timeout=5m + kubectl get nodes + echo + echo "install helm 3" + curl https://raw.githubusercontent.com/helm/helm/master/scripts/get-helm-3 | bash + + - name: Check codespan schema + run: | + git clone https://github.com/kmodules/resource-metadata.git + mv resource-metadata/hub /tmp + rm -rf resource-metadata + codespan-schema-checker --content=./docs diff --git a/.github/workflows/preview-website.yml b/.github/workflows/preview-website.yml new file mode 100644 index 0000000..622871e --- /dev/null +++ b/.github/workflows/preview-website.yml @@ -0,0 +1,89 @@ +name: preview-website + +on: + pull_request: + branches: + - "*" + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} + cancel-in-progress: true + +jobs: + build: + name: Build + runs-on: ubuntu-24.04 + steps: + - uses: actions/checkout@v4 + with: + submodules: true + + - name: Set up Go 1.x + uses: actions/setup-go@v5 + with: + go-version: '1.25' + id: go + + - name: Use Node.js + uses: actions/setup-node@v4 + with: + node-version: '20' + + - name: Install yq + run: | + curl -fsSL -o yqq https://github.com/mikefarah/yq/releases/download/3.3.0/yq_linux_amd64 + chmod +x yqq + sudo mv yqq /usr/local/bin/yqq + pipx install yq + + - name: Install Hugo + run: | + curl -fsSL -o hugo_extended.deb https://github.com/gohugoio/hugo/releases/download/v0.128.2/hugo_extended_0.128.2_linux-amd64.deb + sudo dpkg -i hugo_extended.deb + rm hugo_extended.deb + + - name: Install Hugo Tools + run: | + curl -fsSL -o hugo-tools https://github.com/appscodelabs/hugo-tools/releases/download/v0.2.23/hugo-tools-linux-amd64 + chmod +x hugo-tools + sudo mv hugo-tools /usr/local/bin/hugo-tools + + - name: Clone website repository + env: + GITHUB_USER: 1gtm + GITHUB_TOKEN: ${{ secrets.LGTM_GITHUB_TOKEN }} + WEBSITE_REPOSITORY: ${{ secrets.WEBSITE_REPOSITORY }} + run: | + url="https://${GITHUB_USER}:${GITHUB_TOKEN}@${WEBSITE_REPOSITORY}.git" + cd $RUNNER_WORKSPACE + git clone --recurse-submodules $url + cd $(basename $WEBSITE_REPOSITORY) + git config user.name "${GITHUB_USER}" + git config user.email "${GITHUB_USER}@appscode.com" + + - name: Update docs + env: + GITHUB_USER: 1gtm + GITHUB_TOKEN: ${{ secrets.LGTM_GITHUB_TOKEN }} + WEBSITE_REPOSITORY: ${{ secrets.WEBSITE_REPOSITORY }} + GOOGLE_CUSTOM_SEARCH_API_KEY: ${{ secrets.GOOGLE_CUSTOM_SEARCH_API_KEY }} + run: | + set -x + export WEBSITE_ROOT=$RUNNER_WORKSPACE/$(basename $WEBSITE_REPOSITORY) + cd $WEBSITE_ROOT + npm install + make assets + hugo-tools update-branch --filename=./data/products/kubeobj.json --branch=${{ github.event.pull_request.head.sha }} + make docs-skip-assets + make gen-prod + + - uses: FirebaseExtended/action-hosting-deploy@v0 + with: + repoToken: '${{ secrets.GITHUB_TOKEN }}' + firebaseServiceAccount: '${{ secrets.FIREBASE_SERVICE_ACCOUNT_QA }}' + projectId: kubedb-new-e7965 + # target: kubedb-new-e7965 + entryPoint: '../website' + env: + FIREBASE_CLI_PREVIEWS: hostingchannels diff --git a/.github/workflows/release-tracker.yml b/.github/workflows/release-tracker.yml new file mode 100644 index 0000000..4b79b25 --- /dev/null +++ b/.github/workflows/release-tracker.yml @@ -0,0 +1,41 @@ +name: release-tracker + +on: + pull_request: + types: [closed] + workflow_dispatch: + +concurrency: + group: ${{ github.workflow }}-${{ github.head_ref || github.ref }} + cancel-in-progress: true + +jobs: + build: + runs-on: ubuntu-24.04 + + steps: + - uses: actions/checkout@v4 + + - name: Prepare git + env: + GITHUB_USER: 1gtm + GITHUB_TOKEN: ${{ secrets.LGTM_GITHUB_TOKEN }} + run: | + git config --global user.name "${GITHUB_USER}" + git config --global user.email "${GITHUB_USER}@appscode.com" + git remote set-url origin https://${GITHUB_USER}:${GITHUB_TOKEN}@github.com/${GITHUB_REPOSITORY}.git + + - name: Install GitHub CLI + run: | + curl -fsSL https://github.com/github/hub/raw/master/script/get | bash -s 2.14.1 + sudo mv bin/hub /usr/local/bin + + - name: Update release tracker + if: | + github.event.action == 'closed' && + github.event.pull_request.merged == true + env: + GITHUB_USER: 1gtm + GITHUB_TOKEN: ${{ secrets.LGTM_GITHUB_TOKEN }} + run: | + ./hack/scripts/update-release-tracker.sh diff --git a/.gitignore b/.gitignore index ed6c7b4..9f11b75 100644 --- a/.gitignore +++ b/.gitignore @@ -1,33 +1 @@ -# Compiled Object files, Static and Dynamic libs (Shared Objects) -*.o -*.a -*.so - -# Folders -_obj -_test - -# Architecture specific extensions/prefixes -*.[568vq] -[568vq].out - -*.cgo1.go -*.cgo2.c -_cgo_defun.c -_cgo_gotypes.go -_cgo_export.* - -_testmain.go - -*.exe -*.test -*.prof -/.idea -/dist -**/junit.xml -**/.env -/.vscode -/coverage.txt - -/bin -/.go +.idea/ diff --git a/DCO b/DCO new file mode 100644 index 0000000..716561d --- /dev/null +++ b/DCO @@ -0,0 +1,36 @@ +Developer Certificate of Origin +Version 1.1 + +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. +660 York Street, Suite 102, +San Francisco, CA 94110 USA + +Everyone is permitted to copy and distribute verbatim copies of this +license document, but changing it is not allowed. + + +Developer's Certificate of Origin 1.1 + +By making a contribution to this project, I certify that: + +(a) The contribution was created in whole or in part by me and I + have the right to submit it under the open source license + indicated in the file; or + +(b) The contribution is based upon previous work that, to the best + of my knowledge, is covered under an appropriate open source + license and I have the right under that license to submit that + work with modifications, whether created in whole or in part + by me, under the same open source license (unless I am + permitted to submit under a different license), as indicated + in the file; or + +(c) The contribution was provided directly to me by some other + person who certified (a), (b) or (c) and I have not modified + it. + +(d) I understand and agree that this project and the contribution + are public and that a record of the contribution (including all + personal information I submit with it, including my sign-off) is + maintained indefinitely and may be redistributed consistent with + this project or the open source license(s) involved. diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8dada3e --- /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/docs/concepts/README.md b/docs/concepts/README.md index fa618db..5760b28 100644 --- a/docs/concepts/README.md +++ b/docs/concepts/README.md @@ -1,3 +1,15 @@ +--- +title: Readme +menu: + docs_{{ .version }}: + identifier: readme-concepts + name: Readme + parent: concepts-docs + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # Concepts Concepts help you to learn about the different parts of the NooBaa and the abstractions it uses. diff --git a/docs/concepts/_index.md b/docs/concepts/_index.md new file mode 100755 index 0000000..f1320bb --- /dev/null +++ b/docs/concepts/_index.md @@ -0,0 +1,11 @@ +--- +title: Concepts +menu: + docs_{{ .version }}: + identifier: concepts-docs + name: Concepts + parent: docs-docs + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/concepts/crds/_index.md b/docs/concepts/crds/_index.md new file mode 100755 index 0000000..8f1e94c --- /dev/null +++ b/docs/concepts/crds/_index.md @@ -0,0 +1,11 @@ +--- +title: Crds +menu: + docs_{{ .version }}: + identifier: crds-concepts + name: Crds + parent: concepts-docs + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/concepts/crds/backingstore/index.md b/docs/concepts/crds/backingstore/index.md index 13213c0..26a55e9 100644 --- a/docs/concepts/crds/backingstore/index.md +++ b/docs/concepts/crds/backingstore/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-backingstore + name: Index + parent: backingstore-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # BackingStore ## What is BackingStore diff --git a/docs/concepts/crds/bucketclass/index.md b/docs/concepts/crds/bucketclass/index.md index af8a0c2..422bfcb 100644 --- a/docs/concepts/crds/bucketclass/index.md +++ b/docs/concepts/crds/bucketclass/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-bucketclass + name: Index + parent: bucketclass-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # BucketClass ## What is BucketClass diff --git a/docs/concepts/crds/namespacestore/index.md b/docs/concepts/crds/namespacestore/index.md index 77355d2..5ce9166 100644 --- a/docs/concepts/crds/namespacestore/index.md +++ b/docs/concepts/crds/namespacestore/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-namespacestore + name: Index + parent: namespacestore-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # NamespaceStore ## What is NamespaceStore diff --git a/docs/concepts/crds/noobaa/index.md b/docs/concepts/crds/noobaa/index.md index be96568..c88d26a 100644 --- a/docs/concepts/crds/noobaa/index.md +++ b/docs/concepts/crds/noobaa/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-noobaa + name: Index + parent: noobaa-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # NooBaa ## What is NooBaa diff --git a/docs/concepts/crds/objectbucket/index.md b/docs/concepts/crds/objectbucket/index.md index 6eef59c..76d2c02 100644 --- a/docs/concepts/crds/objectbucket/index.md +++ b/docs/concepts/crds/objectbucket/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-objectbucket + name: Index + parent: objectbucket-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # ObjectBucket ## What is ObjectBucket diff --git a/docs/concepts/crds/objectbucketclaim/index.md b/docs/concepts/crds/objectbucketclaim/index.md index 8537b15..9009130 100644 --- a/docs/concepts/crds/objectbucketclaim/index.md +++ b/docs/concepts/crds/objectbucketclaim/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-objectbucketclaim + name: Index + parent: objectbucketclaim-crds + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # ObjectBucketClaim ## What is ObjectBucketClaim diff --git a/docs/concepts/what-is-noobaa/_index.md b/docs/concepts/what-is-noobaa/_index.md new file mode 100755 index 0000000..f1a6d03 --- /dev/null +++ b/docs/concepts/what-is-noobaa/_index.md @@ -0,0 +1,11 @@ +--- +title: What Is Noobaa +menu: + docs_{{ .version }}: + identifier: what-is-noobaa-concepts + name: What Is Noobaa + parent: concepts-docs + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/concepts/what-is-noobaa/overview/index.md b/docs/concepts/what-is-noobaa/overview/index.md index 7361355..d487e5a 100644 --- a/docs/concepts/what-is-noobaa/overview/index.md +++ b/docs/concepts/what-is-noobaa/overview/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-overview + name: Index + parent: overview-what-is-noobaa + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: concepts +--- + # NooBaa [NooBaa]() is an open-source, cloud-native data management and object storage platform. It enables unified data access, multi-cloud federation, and seamless scalability by abstracting underlying storage resources. NooBaa helps organizations manage, migrate, and protect data across on-premises and cloud environments efficiently. diff --git a/docs/guides/_index.md b/docs/guides/_index.md new file mode 100755 index 0000000..31334b2 --- /dev/null +++ b/docs/guides/_index.md @@ -0,0 +1,11 @@ +--- +title: Guides +menu: + docs_{{ .version }}: + identifier: guides-docs + name: Guides + parent: docs-docs + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/guides/cloud-native-operation/index.md b/docs/guides/cloud-native-operation/index.md index cb5d552..5bb99c5 100644 --- a/docs/guides/cloud-native-operation/index.md +++ b/docs/guides/cloud-native-operation/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-cloud-native-operation + name: Index + parent: cloud-native-operation-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # Cloud-Native S3 Operations with NooBaa NooBaa is designed to provide a cloud-native experience for object storage management within a Kubernetes environment. It leverages Kubernetes Custom Resource Definitions (CRDs) to allow developers and administrators to manage `S3-compatible buckets` declaratively, just like any other Kubernetes resource. diff --git a/docs/guides/data-replication-policy/index.md b/docs/guides/data-replication-policy/index.md index b8a10cd..857027d 100644 --- a/docs/guides/data-replication-policy/index.md +++ b/docs/guides/data-replication-policy/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-data-replication-policy + name: Index + parent: data-replication-policy-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # Bucket Data Replication NooBaa supports data replication policies to asynchronously replicate data from a source bucket to one or more destination buckets. This is essential for disaster recovery and high availability, ensuring your data is protected across multiple locations. diff --git a/docs/guides/high-availability/index.md b/docs/guides/high-availability/index.md index f3b8365..ec8d870 100644 --- a/docs/guides/high-availability/index.md +++ b/docs/guides/high-availability/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-high-availability + name: Index + parent: high-availability-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # High Availability in NooBaa High Availability (HA) is critical for any production storage system. A highly available NooBaa deployment ensures that your data services remain online and accessible even if individual components or nodes fail. This is achieved through redundancy at multiple levels: core services, metadata database, and data placement. diff --git a/docs/guides/monitoring/dashboard/_index.md b/docs/guides/monitoring/dashboard/_index.md new file mode 100755 index 0000000..4f447f7 --- /dev/null +++ b/docs/guides/monitoring/dashboard/_index.md @@ -0,0 +1,11 @@ +--- +title: Dashboard +menu: + docs_{{ .version }}: + identifier: dashboard-monitoring + name: Dashboard + parent: monitoring-guides + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/guides/monitoring/index.md b/docs/guides/monitoring/index.md index f674eb9..ee3e401 100644 --- a/docs/guides/monitoring/index.md +++ b/docs/guides/monitoring/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-monitoring + name: Index + parent: monitoring-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # Monitoring This guide explains how to monitor the NooBaa operator and related components using Prometheus and Grafana. It covers recommended setup, how to expose metrics, example ServiceMonitor manifests, basic alerting rules and troubleshooting steps. diff --git a/docs/guides/multi-cloud-federation/index.md b/docs/guides/multi-cloud-federation/index.md index 8d33257..cf829a3 100644 --- a/docs/guides/multi-cloud-federation/index.md +++ b/docs/guides/multi-cloud-federation/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-multi-cloud-federation + name: Index + parent: multi-cloud-federation-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # Multi Hybrid Cloud Data Federation ## Overview diff --git a/docs/guides/on-prem-with-scalability/index.md b/docs/guides/on-prem-with-scalability/index.md index 61b7cce..0c0503c 100644 --- a/docs/guides/on-prem-with-scalability/index.md +++ b/docs/guides/on-prem-with-scalability/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-on-prem-with-scalability + name: Index + parent: on-prem-with-scalability-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # On-Premises S3 Object Storage with Scalability ## Overview diff --git a/docs/guides/unified-data-access/index.md b/docs/guides/unified-data-access/index.md index 8969546..8072aff 100644 --- a/docs/guides/unified-data-access/index.md +++ b/docs/guides/unified-data-access/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-unified-data-access + name: Index + parent: unified-data-access-guides + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: guides +--- + # Unified Data Access with NooBaa NooBaa provides unified data access by allowing you to connect to various storage resources, whether they are in the cloud or on-premises, and manage them through a single S3-compatible endpoint. This is primarily achieved using **Namespace Stores**. diff --git a/docs/setup/_index.md b/docs/setup/_index.md new file mode 100755 index 0000000..5612d9c --- /dev/null +++ b/docs/setup/_index.md @@ -0,0 +1,11 @@ +--- +title: Setup +menu: + docs_{{ .version }}: + identifier: setup-docs + name: Setup + parent: docs-docs + weight: 1 +menu_name: docs_{{ .version }} +--- + diff --git a/docs/setup/install/index.md b/docs/setup/install/index.md index 4f2fa12..2a48b06 100644 --- a/docs/setup/install/index.md +++ b/docs/setup/install/index.md @@ -1,3 +1,15 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-install + name: Index + parent: install-setup + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: setup +--- + # Installation Guide This guide sets up **NooBaa** with **PostgreSQL (via KubeDB)** and **backup support (via KubeStash)**. You must complete this installation before exploring any NooBaa features. diff --git a/docs/setup/upgrade/index.md b/docs/setup/upgrade/index.md index 7c05b13..72ce475 100644 --- a/docs/setup/upgrade/index.md +++ b/docs/setup/upgrade/index.md @@ -1 +1,13 @@ +--- +title: Index +menu: + docs_{{ .version }}: + identifier: index-upgrade + name: Index + parent: upgrade-setup + weight: 1 +menu_name: docs_{{ .version }} +section_menu_id: setup +--- + https://github.com/noobaa/noobaa-operator/issues/171#issuecomment-847759757 \ No newline at end of file diff --git a/hack/scripts/open-pr.sh b/hack/scripts/open-pr.sh new file mode 100755 index 0000000..e56a9ed --- /dev/null +++ b/hack/scripts/open-pr.sh @@ -0,0 +1,42 @@ +#!/bin/bash + +# Copyright The KubeVault Authors. +# +# 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. + +set -eou pipefail + +SCRIPT_ROOT=$(realpath $(dirname "${BASH_SOURCE[0]}")/../..) +SCRIPT_NAME=$(basename "${BASH_SOURCE[0]}") +pushd $SCRIPT_ROOT + +# http://redsymbol.net/articles/bash-exit-traps/ +function cleanup() { + popd +} +trap cleanup EXIT + +git add --all +if git diff -s --exit-code HEAD; then + echo "Docs are already up-to-date!" + exit 0 +fi + +pr_branch=${GITHUB_REPOSITORY}@${GITHUB_SHA:0:8} +git checkout -b $pr_branch +git commit -a -s -m "Update docs for $pr_branch" +git push -u origin HEAD +hub pull-request \ + --labels automerge \ + --message "Update docs for $pr_branch" \ + --message "$(git show -s --format=%b)" diff --git a/hack/scripts/update-release-tracker.sh b/hack/scripts/update-release-tracker.sh new file mode 100755 index 0000000..7184cb6 --- /dev/null +++ b/hack/scripts/update-release-tracker.sh @@ -0,0 +1,72 @@ +#!/bin/bash + +# Copyright AppsCode Inc. and Contributors +# +# 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. + +set -eou pipefail + +# ref: https://gist.github.com/joshisa/297b0bc1ec0dcdda0d1625029711fa24 +parse_url() { + proto="$(echo $1 | grep :// | sed -e's,^\(.*://\).*,\1,g')" + # remove the protocol + url="$(echo ${1/$proto/})" + + IFS='/' # / is set as delimiter + read -ra PARTS <<<"$url" # str is read into an array as tokens separated by IFS + if [ ${PARTS[0]} != 'github.com' ] || [ ${#PARTS[@]} -ne 5 ]; then + echo "failed to parse relase-tracker: $url" + exit 1 + fi + export RELEASE_TRACKER_OWNER=${PARTS[1]} + export RELEASE_TRACKER_REPO=${PARTS[2]} + export RELEASE_TRACKER_PR=${PARTS[4]} +} + +RELEASE_TRACKER=${RELEASE_TRACKER:-} +GITHUB_BASE_REF=${GITHUB_BASE_REF:-} + +while IFS=$': \r\t' read -r -u9 marker v; do + case $marker in + Release-tracker) + export RELEASE_TRACKER=$(echo $v | tr -d '\r\t') + ;; + Release) + export RELEASE=$(echo $v | tr -d '\r\t') + ;; + esac +done 9< <(git show -s --format=%b) + +[ ! -z "$RELEASE_TRACKER" ] || { + echo "Release-tracker url not found." + exit 0 +} + +[ ! -z "$GITHUB_BASE_REF" ] || { + echo "GitHub base ref not found." + exit 0 +} + +parse_url $RELEASE_TRACKER +api_url="repos/${RELEASE_TRACKER_OWNER}/${RELEASE_TRACKER_REPO}/issues/${RELEASE_TRACKER_PR}/comments" + +case $GITHUB_BASE_REF in + master) + msg="/ready-to-tag github.com/${GITHUB_REPOSITORY} ${GITHUB_SHA}" + ;; + *) + msg="/cherry-picked github.com/${GITHUB_REPOSITORY} ${GITHUB_BASE_REF} ${GITHUB_SHA}" + ;; +esac + +hub api "$api_url" -f body="$msg"