Skip to content
This repository was archived by the owner on Dec 13, 2023. It is now read-only.

ArangoDeployment spec.architecture missing from docs #1141

Closed
ddelange opened this issue Oct 10, 2022 · 7 comments · Fixed by #1178 or #1187
Closed

ArangoDeployment spec.architecture missing from docs #1141

ddelange opened this issue Oct 10, 2022 · 7 comments · Fixed by #1178 or #1187

Comments

@ddelange
Copy link

ddelange commented Oct 10, 2022

Hi! 👋

The documentation for ArangoDeployment is missing an entry for spec.architecture which is a list[str] introduced in arangodb/kube-arangodb#900 and needed to run 3.10 on ARM64 processors.

@ddelange ddelange changed the title spec.architectures missing from docs ArangoDeployment spec.architecture missing from docs Oct 10, 2022
@ddelange
Copy link
Author

fwiw in the original implementation there was an error "Only one architecture type is supported currently", but that seems to have disappeared before/during/after merging that PR.

only the first architecture specified here is respected, however. the rest is ignored (only one nodeAffinity is added to the pods). maybe the error should not have gone 🤔 ref arangodb/arangodb-docker#110 (comment)

@ddelange
Copy link
Author

fwiw, <group>.id is also missing from docs ref arangodb/kube-arangodb#1141 (comment)

@ddelange
Copy link
Author

@nerpaula @Simran-B I think this should be re-opened:

as far as I can see, the linked PR documents the arango operator's spec.architectures field, not the ArangoDeployment resource's spec.architecture field.

the operator supports multiple architectures passed as list[str], whereas the ArangoDeployment field is list[str] but only supports one architecture in that list, see previous comments above.

@Simran-B
Copy link
Collaborator

@ddelange Thanks for pointing out that something isn't right with the new content. I clarified with @jwierzbo that the deployment specification uses spec.architecture (singular) for defining an architecture, and it should normally be a list with a single item only. However, for the purpose of migrating to a different architecture, you can specify two architectures, and the first one defines the architecture you want to migrate to. After the migration, the old architecture should be removed from the list. It's being discussed internally whether a secondary architecture should be supported as a fallback, i.e. having two architectures in the deployment specification permanently.

Clarifications PR: #1187

@ddelange
Copy link
Author

awesome thanks so much for the quick action and the clear explanation!

@ddelange
Copy link
Author

@Simran-B spec.architecture seems still missing in the ArangoDeployment resource docs, is this part not auto-generated? also related to arangodb/docs-hugo#215

@Simran-B
Copy link
Collaborator

#1187 is not merged yet, and we typically re-publish the docs for a release (v3.9.5 is imminent).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
2 participants