Skip to content

Commit 90249fd

Browse files
ShaunaDiazShaunaDiaz
authored
Merge pull request #81439 from ShaunaDiaz/OSDOCS-11882
OSDOCS-11882: adds module to IPv6 config MicroShift
2 parents edf8806 + 9a18258 commit 90249fd

6 files changed

+48
-7
lines changed

‎microshift_configuring/microshift-nw-ipv6-config.adoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ include::modules/microshift-nw-ipv6-dual-stack-config.adoc[leveloffset=+1]
1616

1717
include::modules/microshift-nw-ipv6-dual-stack-migrating-config.adoc[leveloffset=+1]
1818

19+
include::modules/microshift-nw-ipv6-dual-stack-reset-ipfam.adoc[leveloffset=+1]
20+
1921
//OCP module, edit with conditionals and care
2022
include::modules/nw-ovn-kuberentes-limitations.adoc[leveloffset=+1]
2123

‎modules/microshift-nw-ipv6-concept.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift_configuring/microshift-using-config-tools.adoc
3+
// * microshift_configuring/microshift-nw-ipv6-config.adoc
44

55
:_mod-docs-content-type: CONCEPT
66
[id="microshift-intro-ipv6_{context}"]

‎modules/microshift-nw-ipv6-dual-stack-config.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift_configuring/microshift-using-config-tools.adoc
3+
// * microshift_configuring/microshift-nw-ipv6-config.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-configuring-ipv6-dual-stack-config_{context}"]
@@ -68,14 +68,14 @@ node:
6868
<3> Example node IP address. Must be an IPv4 address family.
6969
<4> Example node IP address for dual-stack configuration. Must be an IPv6 address family. Configurable only with dual-stack networking.
7070

71-
. Complete any other configurations you require, then start {microshift-short} by running the following command:
71+
. Complete any other {microshift-short} configurations you require, then start {microshift-short} by running the following command:
7272
+
7373
[source,terminal]
7474
----
7575
$ sudo systemctl start microshift
7676
----
7777

78-
. Restart any application pods or add-on services to enable dual-stack networking.
78+
. Reset the IP family policy for application pods and services as needed, then restart those application pods and services to enable dual-stack networking. See "Resetting the IP family policy for application pods and services" for a simple example.
7979

8080
.Verification
8181

‎modules/microshift-nw-ipv6-dual-stack-migrating-config.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift_configuring/microshift-using-config-tools.adoc
3+
// * microshift_configuring/microshift-nw-ipv6-config.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-nw-ipv6-dual-stack-migrating-config_{context}"]
@@ -87,7 +87,7 @@ node:
8787
$ sudo systemctl restart microshift
8888
----
8989

90-
. Restart any additional services and installed applications.
90+
. Reset the IP family policy for application pods and services as needed, then restart those application pods and services to enable dual-stack networking. See "Resetting the IP family policy for application pods and services" for a simple example.
9191

9292
.Verification
9393

‎modules/microshift-nw-ipv6-dual-stack-reset-ipfam.adoc

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * microshift_configuring/microshift-nw-ipv6-config.adoc
4+
5+
:_mod-docs-content-type: PROCEDURE
6+
[id="microshift-nw-ipv6-dual-stack-reset-ipfam_{context}"]
7+
= Resetting the IP family policy for application pods and services
8+
9+
The default `ipFamilyPolicy` configuration value, `PreferSingleStack`, does not automatically update in all services after you update your {microshift-short} configuration to dual-stack networking. To enable dual-stack networking in services and application pods, you must update the `ipFamilyPolicy` value.
10+
11+
.Prerequisites
12+
13+
* You used the {microshift-short} `config.yaml` to define a dual-stack network with an IPv6 address family.
14+
15+
.Procedure
16+
17+
. Set the `spec.ipFamilyPolicy` field to a valid value for dual-stack networking in your service or pod by using the following example:
18+
+
19+
.Example dual-stack network configuration for a service
20+
[source,yaml]
21+
----
22+
kind: Service
23+
apiVersion: v1
24+
metadata:
25+
name: microshift-new-service
26+
labels: app: microshift-application
27+
spec:
28+
type: NodePort
29+
ipFamilyPolicy: `PreferDualStack` # <1>
30+
# ...
31+
----
32+
<1> Required. Valid values for dual-stack networking are `PreferDualStack` and `RequireDualStack`. The value you set depends on the requirements of your application. `PreferSingleStack` is the default value for the `ipFamilyPolicy` field.
33+
34+
. Restart any application pods that do not have a `hostNetwork` defined. Pods that do have a `hostNetwork` defined do not need to be restarted to update the `ipFamilyPolicy` value.
35+
36+
[NOTE]
37+
====
38+
{microshift-short} system services and pods are automatically updated when the `ipFamilyPolicy` value is updated.
39+
====

‎modules/microshift-nw-ipv6-single-stack-config.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
// Module included in the following assemblies:
22
//
3-
// * microshift_configuring/microshift-using-config-tools.adoc
3+
// * microshift_configuring/microshift-nw-ipv6-config.adoc
44

55
:_mod-docs-content-type: PROCEDURE
66
[id="microshift-configuring-ipv6-single-stack-config_{context}"]

0 commit comments

Comments
 (0)