planetscale / vitess-operator

Kubernetes Operator for Vitess
Apache License 2.0
292 stars 69 forks source link

missing s3_backup_force_path_style #548

Open aep opened 2 months ago

aep commented 2 months ago

according to this change

https://github.com/vitessio/vitess/pull/4200/files

i believe s3_backup_force_path_style is needed to get backup to minio working. hwoever, the CRD doesnt have that option in S3BackupLocation

aep commented 2 months ago

it isnt actually missing. forcePathStyle is just missing from the docs here https://github.com/planetscale/vitess-operator/blob/main/docs/api.md

i would just send a PR, but the docs look autogenerated and i'm not sure from what

mattlord commented 2 months ago

Hi @aep !

it isnt actually missing. forcePathStyle is just missing from the docs here https://github.com/planetscale/vitess-operator/blob/main/docs/api.md

Ah, I was going to say that I knew some people were using minio successfully.

i would just send a PR, but the docs look autogenerated and i'm not sure from what

That would be awesome! ❤️ The docs are built using the generate makefile target:

generate:
        go run sigs.k8s.io/controller-tools/cmd/controller-gen object crd:maxDescLen=0 paths="./pkg/apis/planetscale/v2" output:crd:artifacts:config=./deploy/crds
        go run github.com/ahmetb/gen-crd-api-reference-docs -api-dir planetscale.dev/vitess-operator/pkg/apis/planetscale/v2 -config ./docs/api/config.json -template-dir ./docs/api/template -out-file ./docs/api/index.html

And the docs are built from the code in pkg/apis/planetscale/v2/*.go.

I see it documented here:

docs/api/index.html:<code>forcePathStyle</code></br>
pkg/apis/planetscale/v2/vitessbackupstorage_types.go:   ForcePathStyle bool `json:"forcePathStyle,omitempty"`

What do you think is missing? You expected it to be somewhere else?