diff --git a/Documentation/contributors/design-proposals/operator-validation-library.md b/Documentation/contributors/design-proposals/operator-validation-library.md index 3e3dac9a15..8eb2f48dda 100644 --- a/Documentation/contributors/design-proposals/operator-validation-library.md +++ b/Documentation/contributors/design-proposals/operator-validation-library.md @@ -2,7 +2,7 @@ ### Problem Statement -This project aims to create a validation library within OLM for operators managed by OLM. Such operators are manageable by creating a manifest bundle composed of [ClusterServiceVersions](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md), [CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/), and [Package Manifest](https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades) yamls. The steps to creating these files are error-prone and validation of this bundle happens in scattered places that are not always up to date with the latest changes to the manifest's definition. +This project aims to create a validation library within OLM for operators managed by OLM. Such operators are manageable by creating a manifest bundle composed of [ClusterServiceVersions](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md), [CustomResourceDefinitions](https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/), and [Package Manifest](https://github.com/operator-framework/operator-lifecycle-manager#discovery-catalogs-and-automated-upgrades) yamls. The steps to creating these files are error-prone and validation of this bundle happens in scattered places that are not always up to date with the latest changes to the manifest's definition. For example, operator-sdk's [csv-gen](https://github.com/operator-framework/operator-sdk/blob/master/doc/user/olm-catalog/generating-a-csv.md) tool uses static verification logic based on OLM's CSV type to validate the generated file. There is also [scorecard](https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/scorecard.md) that uses runtime checks to validate the bundle. [operator-courier](https://github.com/operator-framework/operator-courier) uses static verification logic before pushing the bundles to an app-registry. Finally, the [operator-registry](https://github.com/operator-framework/operator-registry) and [olm-operator](https://github.com/operator-framework/operator-lifecycle-manager/tree/master/pkg/controller/operators/olm) both contain logic for static and runtime validation of CSVs. diff --git a/Makefile b/Makefile index 1d4a57e304..032309c17c 100644 --- a/Makefile +++ b/Makefile @@ -80,13 +80,13 @@ run-local: build-linux build-wait rm -rf build . ./scripts/build_local.sh mkdir -p build/resources - . ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml + . ./scripts/package_release.sh 1.0.0 build/resources doc/install/local-values.yaml . ./scripts/install_local.sh $(LOCAL_NAMESPACE) build/resources rm -rf build deploy-local: mkdir -p build/resources - . ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml + . ./scripts/package_release.sh 1.0.0 build/resources doc/install/local-values.yaml . ./scripts/install_local.sh $(LOCAL_NAMESPACE) build/resources rm -rf build diff --git a/README.md b/README.md index 85b9fbfd4c..dc9d54f8d0 100644 --- a/README.md +++ b/README.md @@ -65,7 +65,7 @@ OLM requires that applications be managed by an operator, but that doesn't mean - Package up an existing set of resources for OLM with [helm-app-operator-kit](https://github.com/operator-framework/helm-app-operator-kit) without writing a single line of go. - Use the [operator-sdk](https://github.com/operator-framework/operator-sdk) to quickly build an operator from scratch. -The primary vehicle for describing operator requirements with OLM is a [`ClusterServiceVersion`](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/building-your-csv.md). Once you have an application packaged for OLM, you can deploy it with OLM by creating its `ClusterServiceVersion` in a namespace with a supporting [`OperatorGroup`](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/Documentation/design/operatorgroups.md). +The primary vehicle for describing operator requirements with OLM is a [`ClusterServiceVersion`](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/building-your-csv.md). Once you have an application packaged for OLM, you can deploy it with OLM by creating its `ClusterServiceVersion` in a namespace with a supporting [`OperatorGroup`](https://github.com/operator-framework/operator-lifecycle-manager/blob/master/doc/design/operatorgroups.md). ClusterServiceVersions can be collected into `CatalogSource`s which will allow automated installation and dependency resolution via an `InstallPlan`, and can be kept up-to-date with a `Subscription`. @@ -144,14 +144,14 @@ See the [proposal docs][proposals_docs] and issues for ongoing or planned work. Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details. -[architecture]: /Documentation/design/architecture.md -[philosophy]: /Documentation/design/philosophy.md -[installation guide]: /Documentation/install/install.md +[architecture]: /doc/design/architecture.md +[philosophy]: /doc/design/philosophy.md +[installation guide]: /doc/install/install.md [git_tool]:https://git-scm.com/downloads [go_tool]:https://golang.org/dl/ [docker_tool]:https://docs.docker.com/install/ [podman_tool]:https://github.com/containers/libpod/blob/master/install.md [buildah_tool]:https://github.com/containers/buildah/blob/master/install.md [kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/ -[proposals_docs]: ./Documentation/contributors/design-proposals +[proposals_docs]: ./doc/contributors/design-proposals [license_file]:./LICENSE diff --git a/doc/design/developing.md b/doc/design/developing.md index e69e36709b..4b6f44f8a7 100644 --- a/doc/design/developing.md +++ b/doc/design/developing.md @@ -6,7 +6,7 @@ * Make any config customizations by editing `example-values.yaml` * Deploy a namespaced copy of OLM ```sh -./scripts/package_release.sh 1.0.0-custom custom-olm ./Documentation/install/example-values.yaml +./scripts/package_release.sh 1.0.0-custom custom-olm ./doc/install/example-values.yaml kubectl create ns olm-testing kubectl get secrets -n tectonic-system -o yaml coreos-pull-secret | sed 's/tectonic-system/olm-testing/g' | kubectl create -f - kubectl apply -f ./custom-olm @@ -58,7 +58,7 @@ kubectl apply -f ./custom-olm * either apply the new configmap on its own and restart the catalog or, easier, just run: ```sh -./scripts/package_release.sh 1.0.0-custom custom-olm ./Documentation/install/example-values.yaml +./scripts/package_release.sh 1.0.0-custom custom-olm ./doc/install/example-values.yaml kubectl apply -f ./custom-olm ```