Skip to content

Commit d6056dd

Browse files
authored
Merge pull request #1031 from dimitraz/fix-links
Fix broken doc links
2 parents 8ed387b + 6319bca commit d6056dd

File tree

4 files changed

+10
-10
lines changed

4 files changed

+10
-10
lines changed

Documentation/contributors/design-proposals/operator-validation-library.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
### Problem Statement
44

5-
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.
5+
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.
66

77
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.
88

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ run-local: build-linux build-wait
8080
rm -rf build
8181
. ./scripts/build_local.sh
8282
mkdir -p build/resources
83-
. ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml
83+
. ./scripts/package_release.sh 1.0.0 build/resources doc/install/local-values.yaml
8484
. ./scripts/install_local.sh $(LOCAL_NAMESPACE) build/resources
8585
rm -rf build
8686

8787
deploy-local:
8888
mkdir -p build/resources
89-
. ./scripts/package_release.sh 1.0.0 build/resources Documentation/install/local-values.yaml
89+
. ./scripts/package_release.sh 1.0.0 build/resources doc/install/local-values.yaml
9090
. ./scripts/install_local.sh $(LOCAL_NAMESPACE) build/resources
9191
rm -rf build
9292

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ OLM requires that applications be managed by an operator, but that doesn't mean
6565
- 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.
6666
- Use the [operator-sdk](https://github.com/operator-framework/operator-sdk) to quickly build an operator from scratch.
6767

68-
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).
68+
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).
6969

7070
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`.
7171

@@ -144,14 +144,14 @@ See the [proposal docs][proposals_docs] and issues for ongoing or planned work.
144144

145145
Operator Lifecycle Manager is under Apache 2.0 license. See the [LICENSE][license_file] file for details.
146146

147-
[architecture]: /Documentation/design/architecture.md
148-
[philosophy]: /Documentation/design/philosophy.md
149-
[installation guide]: /Documentation/install/install.md
147+
[architecture]: /doc/design/architecture.md
148+
[philosophy]: /doc/design/philosophy.md
149+
[installation guide]: /doc/install/install.md
150150
[git_tool]:https://git-scm.com/downloads
151151
[go_tool]:https://golang.org/dl/
152152
[docker_tool]:https://docs.docker.com/install/
153153
[podman_tool]:https://github.com/containers/libpod/blob/master/install.md
154154
[buildah_tool]:https://github.com/containers/buildah/blob/master/install.md
155155
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
156-
[proposals_docs]: ./Documentation/contributors/design-proposals
156+
[proposals_docs]: ./doc/contributors/design-proposals
157157
[license_file]:./LICENSE

doc/design/developing.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
* Make any config customizations by editing `example-values.yaml`
77
* Deploy a namespaced copy of OLM
88
```sh
9-
./scripts/package_release.sh 1.0.0-custom custom-olm ./Documentation/install/example-values.yaml
9+
./scripts/package_release.sh 1.0.0-custom custom-olm ./doc/install/example-values.yaml
1010
kubectl create ns olm-testing
1111
kubectl get secrets -n tectonic-system -o yaml coreos-pull-secret | sed 's/tectonic-system/olm-testing/g' | kubectl create -f -
1212
kubectl apply -f ./custom-olm
@@ -58,7 +58,7 @@ kubectl apply -f ./custom-olm
5858
* either apply the new configmap on its own and restart the catalog or, easier, just run:
5959

6060
```sh
61-
./scripts/package_release.sh 1.0.0-custom custom-olm ./Documentation/install/example-values.yaml
61+
./scripts/package_release.sh 1.0.0-custom custom-olm ./doc/install/example-values.yaml
6262
kubectl apply -f ./custom-olm
6363
```
6464

0 commit comments

Comments
 (0)