Revise Service concept, part 13 #38563

sftim · 2022-12-19T21:43:40Z

Split out from #30817
View that PR to see these changes in context.

revise a section of the Service concept [preview; original]

These changes reorganize the structure of the page to provide a new focus on the 4 types of Service. These changes are the ones that come after what you can see in #38562.

sftim · 2022-12-19T21:44:53Z

content/en/docs/concepts/services-networking/service.md

-For example, the Service `redis-primary` which exposes TCP port 6379 and has been
-allocated cluster IP address 10.0.0.11, produces the following environment
-variables:
-
-```shell
-REDIS_PRIMARY_SERVICE_HOST=10.0.0.11
-REDIS_PRIMARY_SERVICE_PORT=6379
-REDIS_PRIMARY_PORT=tcp://10.0.0.11:6379
-REDIS_PRIMARY_PORT_6379_TCP=tcp://10.0.0.11:6379
-REDIS_PRIMARY_PORT_6379_TCP_PROTO=tcp
-REDIS_PRIMARY_PORT_6379_TCP_PORT=6379
-REDIS_PRIMARY_PORT_6379_TCP_ADDR=10.0.0.11
-```
-
-{{< note >}}
-When you have a Pod that needs to access a Service, and you are using
-the environment variable method to publish the port and cluster IP to the client
-Pods, you must create the Service *before* the client Pods come into existence.
-Otherwise, those client Pods won't have their environment variables populated.
-
-If you only use DNS to discover the cluster IP for a Service, you don't need to
-worry about this ordering issue.
-{{< /note >}}


Moved - see https://github.com/kubernetes/website/pull/38563/files#diff-cf41062ebff432932ae2a9aaa18e815626e7ad97ce7a1125cbed9a30bc8c21a6R1116

sftim · 2022-12-19T21:45:29Z

content/en/docs/concepts/services-networking/service.md

-## Choosing your own IP address
-
-You can specify your own cluster IP address as part of a `Service` creation
-request.  To do this, set the `.spec.clusterIP` field. For example, if you
-already have an existing DNS entry that you wish to reuse, or legacy systems
-that are configured for a specific IP address and difficult to re-configure.
-
-The IP address that you choose must be a valid IPv4 or IPv6 address from within the
-`service-cluster-ip-range` CIDR range that is configured for the API server.
-If you try to create a Service with an invalid clusterIP address value, the API
-server will return a 422 HTTP status code to indicate that there's a problem.


Moved; see https://github.com/kubernetes/website/pull/38563/files#diff-cf41062ebff432932ae2a9aaa18e815626e7ad97ce7a1125cbed9a30bc8c21a6R408

sftim · 2022-12-19T21:46:11Z

content/en/docs/concepts/services-networking/service.md

+### Environment variables
+
+When a Pod is run on a Node, the kubelet adds a set of environment variables
+for each active Service. It adds `{SVCNAME}_SERVICE_HOST` and `{SVCNAME}_SERVICE_PORT` variables,
+where the Service name is upper-cased and dashes are converted to underscores.
+It also supports variables (see [makeLinkVariables](https://github.com/kubernetes/kubernetes/blob/dd2d12f6dc0e654c15d5db57a5f9f6ba61192726/pkg/kubelet/envvars/envvars.go#L72))
+that are compatible with Docker Engine's
+"_[legacy container links](https://docs.docker.com/network/links/)_" feature.
+
+For example, the Service `redis-primary` which exposes TCP port 6379 and has been
+allocated cluster IP address 10.0.0.11, produces the following environment
+variables:
+
+```shell
+REDIS_PRIMARY_SERVICE_HOST=10.0.0.11
+REDIS_PRIMARY_SERVICE_PORT=6379
+REDIS_PRIMARY_PORT=tcp://10.0.0.11:6379
+REDIS_PRIMARY_PORT_6379_TCP=tcp://10.0.0.11:6379
+REDIS_PRIMARY_PORT_6379_TCP_PROTO=tcp
+REDIS_PRIMARY_PORT_6379_TCP_PORT=6379
+REDIS_PRIMARY_PORT_6379_TCP_ADDR=10.0.0.11


This is moved, not net new.

sftim · 2022-12-19T21:46:22Z

content/en/docs/concepts/services-networking/service.md

+### DNS
+
+You can (and almost always should) set up a DNS service for your Kubernetes
+cluster using an [add-on](/docs/concepts/cluster-administration/addons/).
+
+A cluster-aware DNS server, such as CoreDNS, watches the Kubernetes API for new
+Services and creates a set of DNS records for each one.  If DNS has been enabled
+throughout your cluster then all Pods should automatically be able to resolve
+Services by their DNS name.
+
+For example, if you have a Service called `my-service` in a Kubernetes
+namespace `my-ns`, the control plane and the DNS Service acting together
+create a DNS record for `my-service.my-ns`. Pods in the `my-ns` namespace
+should be able to find the service by doing a name lookup for `my-service`
+(`my-service.my-ns` would also work).
+
+Pods in other namespaces must qualify the name as `my-service.my-ns`. These names
+will resolve to the cluster IP assigned for the Service.
+
+Kubernetes also supports DNS SRV (Service) records for named ports.  If the
+`my-service.my-ns` Service has a port named `http` with the protocol set to
+`TCP`, you can do a DNS SRV query for `_http._tcp.my-service.my-ns` to discover
+the port number for `http`, as well as the IP address.


This is moved, not net new. I also rewrote it.

netlify · 2022-12-19T21:58:46Z

✅ Pull request preview available for checking

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`c148e37`
🔍 Latest deploy log	https://app.netlify.com/sites/kubernetes-io-main-staging/deploys/643d02c7aab0290008d677c2
😎 Deploy Preview	https://deploy-preview-38563--kubernetes-io-main-staging.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

content/en/docs/concepts/services-networking/service.md

sftim · 2023-02-16T19:46:47Z

I simplified this PR, putting some of the changes into #39499 instead.

sftim · 2023-02-23T13:15:51Z

content/en/docs/concepts/services-networking/service.md

+<!-- preserve existing hyperlinks -->
+<a id="shortcomings" />
+<a id="the-gory-details-of-virtual-ips" />
+<a id="proxy-modes" />
+<a id="proxy-mode-userspace" />
+<a id="proxy-mode-iptables" />
+<a id="proxy-mode-ipvs" />
+<a id="ips-and-vips" />


This is moved from its previous home near the end of the page.

sftim · 2023-02-23T13:19:00Z

Further revised - I think it's ready for review again.

I can't see an easy way to make this change smaller and still be useful to merge in one go.

content/en/docs/concepts/services-networking/service.md

These changes reorganize the structure of the page to provide a new focus on the 4 types of Service.

kbhawkey · 2023-05-11T01:28:21Z

/approve

k8s-ci-robot · 2023-05-11T01:28:28Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: kbhawkey

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:

~~content/en/OWNERS~~ [kbhawkey]

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

windsonsea · 2023-05-16T01:04:44Z

/lgtm

k8s-ci-robot · 2023-05-16T01:04:52Z

LGTM label has been added.

Git tree hash: 25272abde400d28e7d936e775e26b5bccd1dc2f9

k8s-ci-robot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Dec 19, 2022

k8s-ci-robot requested review from kbhawkey and natalisucks December 19, 2022 21:43

k8s-ci-robot added language/en Issues or PRs related to English language sig/docs Categorizes an issue or PR as relevant to SIG Docs. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 19, 2022

sftim mentioned this pull request Dec 19, 2022

Revise concept & reference docs for Services, Ingress & networking #30817

Closed

sftim marked this pull request as ready for review December 19, 2022 21:44

k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Dec 19, 2022

k8s-ci-robot requested review from onlydole and reylejano December 19, 2022 21:44

sftim commented Dec 19, 2022

View reviewed changes

sftim mentioned this pull request Dec 19, 2022

Revise introduction to Service page #38562

Merged

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 23, 2022

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from 3c9ec82 to fa5837f Compare January 10, 2023 17:25

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 10, 2023

tengqm reviewed Jan 14, 2023

View reviewed changes

content/en/docs/concepts/services-networking/service.md Outdated Show resolved Hide resolved

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Jan 31, 2023

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from fa5837f to 6e36e37 Compare February 16, 2023 19:35

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Feb 16, 2023

sftim mentioned this pull request Feb 16, 2023

Revise Service concept, part 14 #39499

Merged

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch 2 times, most recently from c5f3848 to cb152eb Compare February 16, 2023 19:45

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from cb152eb to ff8d0e3 Compare February 17, 2023 11:43

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch 3 times, most recently from 161c1cb to 051551e Compare February 23, 2023 13:15

sftim commented Feb 23, 2023

View reviewed changes

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from 051551e to fcda9e9 Compare February 23, 2023 13:17

kbhawkey reviewed Feb 26, 2023

View reviewed changes

content/en/docs/concepts/services-networking/service.md Show resolved Hide resolved

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from fcda9e9 to a0d80ea Compare February 27, 2023 09:18

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 8, 2023

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from a0d80ea to e5dfc37 Compare March 8, 2023 09:19

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Mar 8, 2023

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from e5dfc37 to 73ea29a Compare March 13, 2023 13:11

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from 73ea29a to a4b74c8 Compare April 13, 2023 16:26

sftim mentioned this pull request Apr 13, 2023

Reorganise part of the Service concept #40671

Closed

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 15, 2023

Revise Service concept

c148e37

These changes reorganize the structure of the page to provide a new focus on the 4 types of Service.

sftim force-pushed the 20221219_revise_service_concept_after_introduction_for_a_bit branch from a4b74c8 to c148e37 Compare April 17, 2023 08:26

k8s-ci-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Apr 17, 2023

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 11, 2023

k8s-ci-robot assigned windsonsea May 16, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label May 16, 2023

k8s-ci-robot merged commit d219572 into kubernetes:main May 16, 2023

sftim deleted the 20221219_revise_service_concept_after_introduction_for_a_bit branch July 2, 2023 19:32

dancer1325 mentioned this pull request Dec 10, 2023

Remove duplicated wording reference to Docker Engine's legacy container links #44272

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Revise Service concept, part 13 #38563

Revise Service concept, part 13 #38563

sftim commented Dec 19, 2022

sftim Dec 19, 2022

sftim Dec 19, 2022

sftim Dec 19, 2022

sftim Dec 19, 2022

netlify bot commented Dec 19, 2022 •

edited

Loading

sftim commented Feb 16, 2023

sftim Feb 23, 2023

sftim commented Feb 23, 2023

kbhawkey commented May 11, 2023

k8s-ci-robot commented May 11, 2023

windsonsea commented May 16, 2023

k8s-ci-robot commented May 16, 2023

Revise Service concept, part 13 #38563

Revise Service concept, part 13 #38563

Conversation

sftim commented Dec 19, 2022

sftim Dec 19, 2022

Choose a reason for hiding this comment

sftim Dec 19, 2022

Choose a reason for hiding this comment

sftim Dec 19, 2022

Choose a reason for hiding this comment

sftim Dec 19, 2022

Choose a reason for hiding this comment

netlify bot commented Dec 19, 2022 • edited Loading

✅ Pull request preview available for checking

sftim commented Feb 16, 2023

sftim Feb 23, 2023

Choose a reason for hiding this comment

sftim commented Feb 23, 2023

kbhawkey commented May 11, 2023

k8s-ci-robot commented May 11, 2023

windsonsea commented May 16, 2023

k8s-ci-robot commented May 16, 2023

netlify bot commented Dec 19, 2022 •

edited

Loading