Skip to content

Commit

Permalink
Further refactor
Browse files Browse the repository at this point in the history
- Move the the OLM tagging module to the Next steps section
  * The language in this module is not consistent with the rest of the
  content. I need to rework this after 4.14 GA
- Move the validation module to the run bundle validate docs
- Include the bundle and deploy steps in the Next steps section
  Otherwise, your changes won't sync
  • Loading branch information
Michael Peter committed Sep 29, 2023
1 parent e492e7a commit 456179e
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 9 deletions.
2 changes: 1 addition & 1 deletion modules/osdk-multi-arch-validate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

:_content-type: PROCEDURE
[id="osdk-multi-arch-validate_{context}"]
= Validating your Operator's support for multiple architectures
= Validating your Operator's multi-platform readiness

You can use the Operator SDK `bundle validate` command to verify that the images defined in the cluster service version (CSV) deployment spec comply with the best practices as defined by the Operator Framework community.

Expand Down
6 changes: 6 additions & 0 deletions operators/operator_sdk/osdk-bundle-validate.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,9 @@ include::modules/osdk-bundle-validate-tests.adoc[leveloffset=+1]
* xref:../../operators/understanding/olm-packaging-format.adoc#olm-bundle-format_olm-packaging-format[Bundle format]
include::modules/osdk-bundle-validate-run.adoc[leveloffset=+1]
include::modules/osdk-multi-arch-validate.adoc[leveloffset=+1]

[role="_additional-resources"]
.Additional resources

* xref:../../operators/operator_sdk/osdk-multi-arch-support.adoc#osdk-multi-platform-support[Configuring Operator projects for multi-platform support]
20 changes: 12 additions & 8 deletions operators/operator_sdk/osdk-multi-arch-support.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
:_content-type: ASSEMBLY
[id="osdk-multiple-platform-support"]
= Configuring Operator projects to support multiple architectures and operating systems
[id="osdk-multi-platform-support"]
= Configuring Operator projects for multi-platform support
include::_attributes/common-attributes.adoc[]
:context: osdk-multi-arch

Expand All @@ -27,17 +27,21 @@ include::modules/osdk-multi-arch-node-reqs.adoc[leveloffset=+2]
[role="_additional-resources"]
.Additional resources
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-configuring-required_nodes-scheduler-node-affinity[Configuring a required node affinity rule]
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-example_nodes-scheduler-node-affinity[Sample node affinity rules]
include::modules/osdk-multi-arch-node-preference.adoc[leveloffset=+2]

[role="_additional-resources"]
.Additional resources
* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-configuring-preferred_nodes-scheduler-node-affinity[Configuring a preferred node affinity rule]
include::modules/osdk-multi-arch-validate.adoc[leveloffset=+1]

[role="_additional-resources"]
[id="additional-resources_osdk-multi-arch-support.adoc"]
== Additional resources
[role="_next-steps"]
[id="next-steps_osdk-multi-arch-support.adoc"]
== Next steps

* xref:../../nodes/scheduling/nodes-scheduler-node-affinity.adoc#nodes-scheduler-node-affinity-example_nodes-scheduler-node-affinity[Sample node affinity rules]
* xref:../../operators/operator_sdk/osdk-generating-csvs.adoc#olm-enabling-operator-for-multi-arch_osdk-generating-csvs[Label the platforms your Operator supports for Operator Lifecycle Manager (OLM)]
* Bundle your Operator and Deploy with OLM
** xref:../../operators/operator_sdk/golang/osdk-golang-tutorial.adoc#osdk-bundle-deploy-olm_osdk-golang-tutorial[Go-based Operator projects]
** xref:../../operators/operator_sdk/ansible/osdk-ansible-tutorial.adoc#osdk-bundle-deploy-olm_osdk-ansible-tutorial[Ansible-based Operator projects]
** xref:../../operators/operator_sdk/helm/osdk-helm-tutorial.html#osdk-bundle-deploy-olm_osdk-helm-tutorial[Helm-bsed Operator projects]
* xref:../../operators/operator_sdk/osdk-bundle-validate.html#osdk-multi-arch-validate_osdk-bundle-validate[Validate your Operator's multi-platform readiness]

0 comments on commit 456179e

Please sign in to comment.