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

NO-JIRA: docs: fixing wrong key name #3833

Merged
merged 2 commits into from Apr 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions api/hypershift/v1beta1/nodepool_types.go
Expand Up @@ -159,15 +159,15 @@ type NodePoolSpec struct {
PausedUntil *string `json:"pausedUntil,omitempty"`

// TuningConfig is a list of references to ConfigMaps containing serialized
// Tuned resources to define the tuning configuration to be applied to
// Tuned or PerformanceProfile resources to define the tuning configuration to be applied to
// nodes in the NodePool. The Tuned API is defined here:
//
// https://github.com/openshift/cluster-node-tuning-operator/blob/2c76314fb3cc8f12aef4a0dcd67ddc3677d5b54f/pkg/apis/tuned/v1/tuned_types.go
//
// The PerformanceProfile API is defined here:
// https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2
//
// Each ConfigMap must have a single key named "tuned" whose value is the
// Each ConfigMap must have a single key named "tuning" whose value is the
// JSON or YAML of a serialized Tuned or PerformanceProfile.
// +kubebuilder:validation:Optional
TuningConfig []corev1.LocalObjectReference `json:"tuningConfig,omitempty"`
Expand Down
Expand Up @@ -2037,7 +2037,7 @@ spec:
tuningConfig:
description: |-
TuningConfig is a list of references to ConfigMaps containing serialized
Tuned resources to define the tuning configuration to be applied to
Tuned or PerformanceProfile resources to define the tuning configuration to be applied to
nodes in the NodePool. The Tuned API is defined here:


Expand All @@ -2048,7 +2048,7 @@ spec:
https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2


Each ConfigMap must have a single key named "tuned" whose value is the
Each ConfigMap must have a single key named "tuning" whose value is the
JSON or YAML of a serialized Tuned or PerformanceProfile.
items:
description: |-
Expand Down
8 changes: 4 additions & 4 deletions docs/content/reference/api.md
Expand Up @@ -826,12 +826,12 @@ provided: reconciliation is paused on the resource until the field is removed.</
</td>
<td>
<p>TuningConfig is a list of references to ConfigMaps containing serialized
Tuned resources to define the tuning configuration to be applied to
Tuned or PerformanceProfile resources to define the tuning configuration to be applied to
nodes in the NodePool. The Tuned API is defined here:</p>
<p><a href="https://github.com/openshift/cluster-node-tuning-operator/blob/2c76314fb3cc8f12aef4a0dcd67ddc3677d5b54f/pkg/apis/tuned/v1/tuned_types.go">https://github.com/openshift/cluster-node-tuning-operator/blob/2c76314fb3cc8f12aef4a0dcd67ddc3677d5b54f/pkg/apis/tuned/v1/tuned_types.go</a></p>
<p>The PerformanceProfile API is defined here:
<a href="https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2">https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2</a></p>
<p>Each ConfigMap must have a single key named &ldquo;tuned&rdquo; whose value is the
<p>Each ConfigMap must have a single key named &ldquo;tuning&rdquo; whose value is the
JSON or YAML of a serialized Tuned or PerformanceProfile.</p>
</td>
</tr>
Expand Down Expand Up @@ -6734,12 +6734,12 @@ provided: reconciliation is paused on the resource until the field is removed.</
</td>
<td>
<p>TuningConfig is a list of references to ConfigMaps containing serialized
Tuned resources to define the tuning configuration to be applied to
Tuned or PerformanceProfile resources to define the tuning configuration to be applied to
nodes in the NodePool. The Tuned API is defined here:</p>
<p><a href="https://github.com/openshift/cluster-node-tuning-operator/blob/2c76314fb3cc8f12aef4a0dcd67ddc3677d5b54f/pkg/apis/tuned/v1/tuned_types.go">https://github.com/openshift/cluster-node-tuning-operator/blob/2c76314fb3cc8f12aef4a0dcd67ddc3677d5b54f/pkg/apis/tuned/v1/tuned_types.go</a></p>
<p>The PerformanceProfile API is defined here:
<a href="https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2">https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2</a></p>
<p>Each ConfigMap must have a single key named &ldquo;tuned&rdquo; whose value is the
<p>Each ConfigMap must have a single key named &ldquo;tuning&rdquo; whose value is the
JSON or YAML of a serialized Tuned or PerformanceProfile.</p>
</td>
</tr>
Expand Down
4 changes: 2 additions & 2 deletions hack/app-sre/saas_template.yaml
Expand Up @@ -57341,7 +57341,7 @@ objects:
tuningConfig:
description: |-
TuningConfig is a list of references to ConfigMaps containing serialized
Tuned resources to define the tuning configuration to be applied to
Tuned or PerformanceProfile resources to define the tuning configuration to be applied to
nodes in the NodePool. The Tuned API is defined here:


Expand All @@ -57352,7 +57352,7 @@ objects:
https://github.com/openshift/cluster-node-tuning-operator/tree/b41042d42d4ba5bb2e99960248cf1d6ae4935018/pkg/apis/performanceprofile/v2


Each ConfigMap must have a single key named "tuned" whose value is the
Each ConfigMap must have a single key named "tuning" whose value is the
JSON or YAML of a serialized Tuned or PerformanceProfile.
items:
description: |-
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.