diff --git a/README.md b/README.md index 4ef97db4..7f28e7bf 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@

- + - + @@ -94,7 +94,7 @@ make helm-docs ## Community -Join the community, share and learn from it. You can find all the resources to how to contribute code and docs, connect with people in the [community repository](https://github.com/clastix/capsule-community). +Join the community, share and learn from it. You can find all the resources to how to contribute code and docs, connect with people in the [community repository](https://github.com/projectcapsule/capsule-community). Please read the [code of conduct](CODE_OF_CONDUCT.md). @@ -122,7 +122,7 @@ Please, refer to the [documentation page](https://capsule.clastix.io/docs/contri - Q. Is it production grade? - A. Although under frequent development and improvements, Capsule is ready to be used in production environments as currently, people are using it in public and private deployments. Check out the [release](https://github.com/clastix/capsule/releases) page for a detailed list of available versions. + A. Although under frequent development and improvements, Capsule is ready to be used in production environments as currently, people are using it in public and private deployments. Check out the [release](https://github.com/projectcapsule/capsule/releases) page for a detailed list of available versions. - Q. Does it work with my Kubernetes XYZ distribution? diff --git a/docs/content/contributing/development.md b/docs/content/contributing/development.md index e56ff8f5..43184ffe 100644 --- a/docs/content/contributing/development.md +++ b/docs/content/contributing/development.md @@ -107,12 +107,12 @@ $ git clone git@github.com:myuser/capsule.git && cd capsule It's a good practice to add the upstream as the remote too so we can easily fetch and merge the upstream to our fork: ```shell -$ git remote add upstream https://github.com/clastix/capsule.git +$ git remote add upstream https://github.com/projectcapsule/capsule.git $ git remote -vv origin git@github.com:myuser/capsule.git (fetch) origin git@github.com:myuser/capsule.git (push) -upstream https://github.com/clastix/capsule.git (fetch) -upstream https://github.com/clastix/capsule.git (push) +upstream https://github.com/projectcapsule/capsule.git (fetch) +upstream https://github.com/projectcapsule/capsule.git (push) ``` Pull all tags diff --git a/docs/content/contributing/governance.md b/docs/content/contributing/governance.md index 6c9af9b0..6c012d88 100644 --- a/docs/content/contributing/governance.md +++ b/docs/content/contributing/governance.md @@ -17,7 +17,7 @@ In the context of Capsule project, we consider the following roles: The release process will be governed by Maintainers. -Please, refer to the [maintainers file](https://github.com/clastix/capsule/blob/master/.github/maintainers.yaml) available in the source code. +Please, refer to the [maintainers file](https://github.com/projectcapsule/capsule/blob/master/.github/maintainers.yaml) available in the source code. ## Roadmap Planning diff --git a/docs/content/contributing/guidelines.md b/docs/content/contributing/guidelines.md index 5d101697..e6ac9717 100644 --- a/docs/content/contributing/guidelines.md +++ b/docs/content/contributing/guidelines.md @@ -59,7 +59,7 @@ You can easily check them issuing the _Make_ recipe `golint`. golangci-lint run -c .golangci.yml ``` -> Enabled linters and related options are defined in the [.golanci.yml file](https://github.com/clastix/capsule/blob/master/.golangci.yml) +> Enabled linters and related options are defined in the [.golanci.yml file](https://github.com/projectcapsule/capsule/blob/master/.golangci.yml) ### goimports @@ -77,7 +77,7 @@ To help you out you can use the _Make_ recipe `goimports` ``` # make goimports -goimports -w -l -local "github.com/clastix/capsule" . +goimports -w -l -local "github.com/projectcapsule/capsule" . ``` ## Finding contributions to work on @@ -108,4 +108,4 @@ Please, add a new single line at end of any file as the current coding style. ## Licensing -See the [LICENSE](https://github.com/clastix/capsule/blob/master/LICENSE) file for our project's licensing. We can ask you to confirm the licensing of your contribution. +See the [LICENSE](https://github.com/projectcapsule/capsule/blob/master/LICENSE) file for our project's licensing. We can ask you to confirm the licensing of your contribution. diff --git a/docs/content/contributing/release.md b/docs/content/contributing/release.md index aadf6a1f..668ab31f 100644 --- a/docs/content/contributing/release.md +++ b/docs/content/contributing/release.md @@ -28,7 +28,7 @@ This will trigger a _GitHub Action_ which builds a multi-arch container image, t ## Helm Chart hosting -The suggested installation tool is [Helm](https://helm.sh), and the Capsule chart is hosted in the [GitHub repository](https://github.com/clastix/capsule/tree/master/charts/capsule). +The suggested installation tool is [Helm](https://helm.sh), and the Capsule chart is hosted in the [GitHub repository](https://github.com/projectcapsule/capsule/tree/master/charts/capsule). For each Helm Chart release, a tit tag with the prefix `helm-v` will be issued to help developers to address the corresponding commit. The built Helm Charts are then automatically pushed upon tag release to the [CLASTIX Helm repository](https://clastix.github.io/charts). diff --git a/docs/content/general/getting-started.md b/docs/content/general/getting-started.md index 5eed9121..979e99e2 100644 --- a/docs/content/general/getting-started.md +++ b/docs/content/general/getting-started.md @@ -9,7 +9,7 @@ Make sure you have access to a Kubernetes cluster as administrator. There are two ways to install Capsule: * Use the [single YAML file installer](https://raw.githubusercontent.com/clastix/capsule/master/config/install.yaml) -* Use the [Capsule Helm Chart](https://github.com/clastix/capsule/blob/master/charts/capsule/README.md) +* Use the [Capsule Helm Chart](https://github.com/projectcapsule/capsule/blob/master/charts/capsule/README.md) ### Install with the single YAML file installer @@ -23,7 +23,7 @@ It will install the Capsule controller in a dedicated namespace `capsule-system` ### Install with Helm Chart -Please, refer to the instructions reported in the Capsule Helm Chart [README](https://github.com/clastix/capsule/blob/master/charts/capsule/README.md). +Please, refer to the instructions reported in the Capsule Helm Chart [README](https://github.com/projectcapsule/capsule/blob/master/charts/capsule/README.md). ## Create your first Tenant @@ -74,7 +74,7 @@ Users authenticated through an _OIDC token_ must have in their token: ] ``` -The [hack/create-user.sh](https://github.com/clastix/capsule/blob/master/hack/create-user.sh) can help you set up a dummy `kubeconfig` for the `alice` user acting as owner of a tenant called `oil` +The [hack/create-user.sh](https://github.com/projectcapsule/capsule/blob/master/hack/create-user.sh) can help you set up a dummy `kubeconfig` for the `alice` user acting as owner of a tenant called `oil` ```bash ./hack/create-user.sh alice oil diff --git a/docs/content/general/lens.md b/docs/content/general/lens.md index ec96f8ad..9db9ff14 100644 --- a/docs/content/general/lens.md +++ b/docs/content/general/lens.md @@ -8,4 +8,4 @@ Capsule extension for Lens provides these capabilities: - See tenant details and change through the embedded Lens editor - Check Resources Quota and Budget at both the tenant and namespace level -Please, see the [README](https://github.com/clastix/capsule-lens-extension) for details about the installation of the Capsule Lens Extension. +Please, see the [README](https://github.com/projectcapsule/capsule-lens-extension) for details about the installation of the Capsule Lens Extension. diff --git a/docs/content/general/proxy.md b/docs/content/general/proxy.md index 246a2193..237df36a 100644 --- a/docs/content/general/proxy.md +++ b/docs/content/general/proxy.md @@ -138,7 +138,7 @@ Each Resource kind can be granted with several verbs, such as: ## Cluster-scoped resources selection strategy precedence -Starting from [Capsule v0.2.0](https://github.com/clastix/capsule/releases/tag/v0.2.0), selection of cluster-scoped resources based on labels has been introduced. +Starting from [Capsule v0.2.0](https://github.com/projectcapsule/capsule/releases/tag/v0.2.0), selection of cluster-scoped resources based on labels has been introduced. Due to the limitations of Kubernetes API Server which not support `OR` label selector, the Capsule core team decided to give precedence to the label selector over the exact and regex match. diff --git a/docs/content/guides/flux2-capsule.md b/docs/content/guides/flux2-capsule.md index 6aa9ca02..fac1baeb 100644 --- a/docs/content/guides/flux2-capsule.md +++ b/docs/content/guides/flux2-capsule.md @@ -180,7 +180,7 @@ To deepen on this please go to [#Insights](#insights). ### How to setup Tenants GitOps-ready -Given that [Capsule](github.com/clastix/capsule) and [Capsule Proxy](github.com/clastix/capsule-proxy) are installed, and [Flux v2](https://github.com/fluxcd/flux2) configured with [multi-tenancy lockdown](https://fluxcd.io/docs/installation/#multi-tenancy-lockdown) features, of which the patch below: +Given that [Capsule](github.com/projectcapsule/capsule) and [Capsule Proxy](github.com/clastix/capsule-proxy) are installed, and [Flux v2](https://github.com/fluxcd/flux2) configured with [multi-tenancy lockdown](https://fluxcd.io/docs/installation/#multi-tenancy-lockdown) features, of which the patch below: ```yaml apiVersion: kustomize.config.k8s.io/v1beta1 @@ -435,7 +435,7 @@ For other protections against threats in this multi-tenancy scenario please see - https://fluxcd.io/docs/installation/#multi-tenancy-lockdown - https://fluxcd.io/blog/2022/05/may-2022-security-announcement/ - https://github.com/clastix/capsule-proxy/issues/218 -- https://github.com/clastix/capsule/issues/528 +- https://github.com/projectcapsule/capsule/issues/528 - https://github.com/clastix/flux2-capsule-multi-tenancy - https://github.com/fluxcd/flux2-multi-tenancy - https://fluxcd.io/docs/guides/repository-structure/ diff --git a/docs/content/guides/monitoring.md b/docs/content/guides/monitoring.md index 9f92f0d8..113a146d 100644 --- a/docs/content/guides/monitoring.md +++ b/docs/content/guides/monitoring.md @@ -18,7 +18,7 @@ To fastly deploy this monitoring stack, consider installing the [Prometheus Oper ## Quick Start -The Capsule Helm [charts](https://github.com/clastix/capsule/tree/master/charts/capsule) allow you to automatically create Kubernetes minimum resources needed for the proper functioning of the dashboard: +The Capsule Helm [charts](https://github.com/projectcapsule/capsule/tree/master/charts/capsule) allow you to automatically create Kubernetes minimum resources needed for the proper functioning of the dashboard: * ServiceMonitor * Role @@ -38,7 +38,7 @@ serviceMonitor: name: namespace: ``` -Take a look at the Helm charts [README.md](https://github.com/clastix/capsule/blob/master/charts/capsule/README.md#customize-the-installation) file for further customization. +Take a look at the Helm charts [README.md](https://github.com/projectcapsule/capsule/blob/master/charts/capsule/README.md#customize-the-installation) file for further customization. ### Check Service Monitor @@ -47,7 +47,7 @@ Verify that the service monitor is working correctly through the Prometheus "tar ![Prometheus Targets](./assets/prometheus_targets.png) ### Deploy dashboard -A dashboard for Grafana is provided as [dashboard.json](https://github.com/clastix/capsule/blob/master/config/grafana/dashboard.json). +A dashboard for Grafana is provided as [dashboard.json](https://github.com/projectcapsule/capsule/blob/master/config/grafana/dashboard.json). Render with `kustomize` the dashboard as a ConfigMap and apply in the namespace where Grafana is installed, making sure to select the correct Prometheus datasource: diff --git a/docs/content/guides/upgrading.md b/docs/content/guides/upgrading.md index caa6f1a9..f68d4dc0 100644 --- a/docs/content/guides/upgrading.md +++ b/docs/content/guides/upgrading.md @@ -2,9 +2,9 @@ List of Tenant API changes: -- [Capsule v0.1.0](https://github.com/clastix/capsule/releases/tag/v0.1.0) bump to `v1beta1` from `v1alpha1`. -- [Capsule v0.2.0](https://github.com/clastix/capsule/releases/tag/v0.2.0) bump to `v1beta2` from `v1beta1`, deprecating `v1alpha1`. -- [Capsule v0.3.0](https://github.com/clastix/capsule/releases/tag/v0.3.0) missing enums required by [Capsule Proxy](https://github.com/clastix/capsule-proxy). +- [Capsule v0.1.0](https://github.com/projectcapsule/capsule/releases/tag/v0.1.0) bump to `v1beta1` from `v1alpha1`. +- [Capsule v0.2.0](https://github.com/projectcapsule/capsule/releases/tag/v0.2.0) bump to `v1beta2` from `v1beta1`, deprecating `v1alpha1`. +- [Capsule v0.3.0](https://github.com/projectcapsule/capsule/releases/tag/v0.3.0) missing enums required by [Capsule Proxy](https://github.com/clastix/capsule-proxy). This document aims to provide support and a guide on how to perform a clean upgrade to the latest API version in order to avoid service disruption and data loss. diff --git a/docs/src/components/AppFooter.vue b/docs/src/components/AppFooter.vue index 910fc08b..2d2f6278 100644 --- a/docs/src/components/AppFooter.vue +++ b/docs/src/components/AppFooter.vue @@ -17,7 +17,7 @@