Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove host networking mentions from documentation and examples #2087

Merged
merged 2 commits into from
Aug 20, 2024

Conversation

mykaul
Copy link
Contributor

@mykaul mykaul commented Aug 20, 2024

We should not recommend nor support it.
Refs: #1378

@scylla-operator-bot scylla-operator-bot bot added do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. needs-priority Indicates a PR lacks a `priority/foo` label and requires one. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Aug 20, 2024
@mykaul mykaul added kind/documentation Categorizes issue or PR as related to documentation. and removed needs-priority Indicates a PR lacks a `priority/foo` label and requires one. labels Aug 20, 2024
@scylla-operator-bot scylla-operator-bot bot removed the do-not-merge/needs-kind Indicates a PR lacks a `kind/foo` label and requires one. label Aug 20, 2024
@zimnx
Copy link
Collaborator

zimnx commented Aug 20, 2024

/approve

We should also remove it from examples (eks and gke are enabling it), would you mind removing these too?

@scylla-operator-bot scylla-operator-bot bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 20, 2024
We should not recommend nor support it.

Signed-off-by: Yaniv Kaul <yaniv.kaul@scylladb.com>
Refs: scylladb#1378
We should not recommend nor support it. Removing it in the examples is the next step after docs.

Signed-off-by: Yaniv Kaul <yaniv.kaul@scylladb.com>
Refs: scylladb#1378
@mykaul
Copy link
Contributor Author

mykaul commented Aug 20, 2024

Added a commit to remove it from the examples. We still have it around in other places, I think these are minor:

kaul@ykaul:~/github/scylla-operator$ grep -Frisn hostNetworking
deploy/operator.yaml:1103:                      description: 'port is the port number used to bind the Alternator API. Deprecated: `port` is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.'
pkg/controller/scyllacluster/resource.go:383:					HostNetwork: c.Spec.Network.HostNetworking,
pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml:74:                      description: 'port is the port number used to bind the Alternator API. Deprecated: `port` is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.'
pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml:2049:                    hostNetworking:
pkg/api/scylla/v1/scylla.scylladb.com_scyllaclusters.yaml:2050:                      description: hostNetworking determines if scylla uses the host's network namespace. Setting this option avoids going through Kubernetes SDN and exposes scylla on node's IP.
pkg/api/scylla/v1/types_cluster.go:438:	// hostNetworking determines if scylla uses the host's network namespace. Setting this option
pkg/api/scylla/v1/types_cluster.go:440:	HostNetworking bool `json:"hostNetworking,omitempty"`
pkg/api/scylla/v1/types_cluster.go:577:	// Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.
docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst:180:     - port is the port number used to bind the Alternator API. Deprecated: `port` is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.
docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst:4564:   * - hostNetworking
docs/source/api-reference/groups/scylla.scylladb.com/scyllaclusters.rst:4566:     - hostNetworking determines if scylla uses the host's network namespace. Setting this option avoids going through Kubernetes SDN and exposes scylla on node's IP.
helm/scylla/values.schema.json:27:          "description": "port is the port number used to bind the Alternator API. Deprecated: `port` is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.",
helm/scylla/values.schema.json:389:        "hostNetworking": {
helm/scylla/values.schema.json:390:          "description": "hostNetworking determines if scylla uses the host's network namespace. Setting this option avoids going through Kubernetes SDN and exposes scylla on node's IP.",
helm/scylla/values.yaml:37:hostNetworking: false
helm/scylla/templates/scyllacluster.yaml:43:  {{- if .Values.hostNetworking}}
helm/scylla/templates/scyllacluster.yaml:45:    hostNetworking: {{ .Values.hostNetworking }}
helm/scylla-manager/values.schema.json:138:              "description": "port is the port number used to bind the Alternator API. Deprecated: `port` is deprecated and may be ignored in the future. Please make sure to avoid using hostNetworking and work with standard Kubernetes concepts like Services.",
helm/scylla-manager/values.schema.json:500:            "hostNetworking": {
helm/scylla-manager/values.schema.json:501:              "description": "hostNetworking determines if scylla uses the host's network namespace. Setting this option avoids going through Kubernetes SDN and exposes scylla on node's IP.",
enhancements/proposals/1978-scylladbdatacenter-api/README.md:66:- We initially thought that `hostNetworking` helps with performance, but later we discovered we were wrong.
enhancements/proposals/1978-scylladbdatacenter-api/README.md:67:  As we only see the downsides of using it, `hostNetworking` support will be discontinued, and setting it becomes deprecated

@zimnx zimnx changed the title Docs: remove host networking. Remove host networking mentions from documentation and examples Aug 20, 2024
@zimnx zimnx added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Aug 20, 2024
@zimnx
Copy link
Collaborator

zimnx commented Aug 20, 2024

The rest are fine, they will be gone once we eventually stop supporting it.
Thanks
/lgtm

@scylla-operator-bot scylla-operator-bot bot added the lgtm Indicates that a PR is ready to be merged. label Aug 20, 2024
@tnozicka
Copy link
Member

I went through a grep as well and it looks like this wasn't actually in too many places modulo the CRD definitions or generated API reference.

/approve
/lgtm

Thanks @mykaul

Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mykaul, tnozicka, zimnx

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@scylla-operator-bot scylla-operator-bot bot merged commit eb6c012 into scylladb:master Aug 20, 2024
13 checks passed
@mykaul
Copy link
Contributor Author

mykaul commented Aug 27, 2024

I assume this should be backported to 1.13 release branch. How do I do it? Manually?

@zimnx
Copy link
Collaborator

zimnx commented Aug 27, 2024

yes, manual backport + PR to v1.13 branch

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/documentation Categorizes issue or PR as related to documentation. lgtm Indicates that a PR is ready to be merged. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants