Jira OCPBUGS-38888: Align RDS SCTP module with documentation

[andreaskaris]

Version(s):

Issue:
Reported-at: #80849

Link to docs preview:
https://80850--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-crs#telco-core-sctp_module_mc-yaml

QE review:

• QE has approved this change.

Additional information:

The fields are in slightly different order from the documentation snippet as I aligned them with the output that one would get from OpenShift (to make a diff with life documentation easier, this is the canonical format for the RDS files as far as I can tell):

# oc get mc load-sctp-module -o yaml
apiVersion: machineconfiguration.openshift.io/v1
kind: MachineConfig
metadata:
(...)
  labels:
    machineconfiguration.openshift.io/role: worker
  name: load-sctp-module
(...)
spec:
  config:
    ignition:
      version: 3.2.0
    storage:
      files:
      - contents:
          source: data:,
        mode: 420
        overwrite: true
        path: /etc/modprobe.d/sctp-blacklist.conf
      - contents:
          source: data:,sctp
        mode: 420
        overwrite: true
        path: /etc/modules-load.d/sctp-load.conf

[andreaskaris]

@openshift/team-documentation
@imiller0

[openshift-ci-robot]

@andreaskaris: This pull request references Jira Issue OCPBUGS-38888, which is invalid:

• expected the bug to target the "4.18.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Reported-at: #80849

Version(s):

Issue:

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

The fields are in slightly different order from the documentation snippet as I aligned them with the output that one would get from OpenShift (to make a diff with life documentation easier, this is the canonical format for the RDS files as far as I can tell):

# oc get mc load-sctp-module -o yaml
apiVersion: machineconfiguration.openshift.io/v1
kind: MachineConfig
metadata:
(...)
 labels:
   machineconfiguration.openshift.io/role: worker
 name: load-sctp-module
(...)
spec:
 config:
   ignition:
     version: 3.2.0
   storage:
     files:
     - contents:
         source: data:,
       mode: 420
       overwrite: true
       path: /etc/modprobe.d/sctp-blacklist.conf
     - contents:
         source: data:,sctp
       mode: 420
       overwrite: true
       path: /etc/modules-load.d/sctp-load.conf

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[andreaskaris]

/jira refresh

[openshift-ci-robot]

@andreaskaris: This pull request references Jira Issue OCPBUGS-38888, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.18.0) matches configured target version for branch (4.18.0)
• bug is in the state New, which is one of the valid states (NEW, ASSIGNED, POST)

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[ocpdocs-previewbot]

🤖 Fri Aug 23 11:48:26 - Prow CI generated the docs preview:

https://80850--ocpdocs-pr.netlify.app/

[openshift-ci]

@andreaskaris: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[openshift-ci-robot]

@andreaskaris: This pull request references Jira Issue OCPBUGS-38888, which is valid.

3 validation(s) were run on this bug

• bug is open, matching expected state (open)
• bug target version (4.18.0) matches configured target version for branch (4.18.0)
• bug is in the state POST, which is one of the valid states (NEW, ASSIGNED, POST)

In response to this:

Reported-at: #80849

Version(s):

Issue:

Link to docs preview:

QE review:

• QE has approved this change.

Additional information:

The fields are in slightly different order from the documentation snippet as I aligned them with the output that one would get from OpenShift (to make a diff with life documentation easier, this is the canonical format for the RDS files as far as I can tell):

# oc get mc load-sctp-module -o yaml
apiVersion: machineconfiguration.openshift.io/v1
kind: MachineConfig
metadata:
(...)
 labels:
   machineconfiguration.openshift.io/role: worker
 name: load-sctp-module
(...)
spec:
 config:
   ignition:
     version: 3.2.0
   storage:
     files:
     - contents:
         source: data:,
       mode: 420
       overwrite: true
       path: /etc/modprobe.d/sctp-blacklist.conf
     - contents:
         source: data:,sctp
       mode: 420
       overwrite: true
       path: /etc/modules-load.d/sctp-load.conf

Preview link:
https://80850--ocpdocs-pr.netlify.app/openshift-enterprise/latest/scalability_and_performance/telco_ref_design_specs/core/telco-core-ref-crs#telco-core-sctp_module_mc-yaml

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

[ShaunaDiaz]

@andreaskaris What versions of the docs does this fix apply to? I have also requested a review from a member of the Telco docs team, who can help with additional QE or SME reviews needed.

[andreaskaris]

It should go to latest all the way down to OCP 4.14

[andreaskaris]

@imiller0 might want to have a look

[imiller0]

We need to update the actual reference configuration here first and then pull that into the docs.
cc: @aireilly

[aireilly]

Let's update the docs when the YAML is available in the ztp-site-generate container.