Skip to content

Fix style for options that are not compulsory #20616

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

Merged
merged 1 commit into from
May 15, 2020
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modules/cluster-logging-collector-fluentd.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ For example:
$ oc create configmap secure-forward --from-file=secure-forward.conf -n openshift-logging
----

. Optionally, import any secrets required for the receiver:
. Optional: Import any secrets required for the receiver:
+
----
$ oc create secret generic secure-forward --from-file=<arbitrary-name-of-key1>=cert_file_from_fluentd_receiver --from-literal=shared_key=value_from_fluentd_receiver
Expand Down
2 changes: 1 addition & 1 deletion modules/migration-running-migration-plan-cam.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ You can run *Stage* multiple times to reduce the actual migration time.
+
*Migrate* stops the application workload on the source cluster and recreates its resources on the target cluster.

. Optionally, in the *Migrate* window, you can select *Do not stop applications on the source cluster during migration*.
. Optional: In the *Migrate* window, you can select *Do not stop applications on the source cluster during migration*.
. Click *Migrate*.
. When the migration is complete, verify that the application migrated successfully in the {product-title} web console:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ data:

. Save the file to apply the changes. Monitoring your own services is enabled automatically.

. Optionally, you can check that the `prometheus-user-workload` pods were created:
. Optional: You can check that the `prometheus-user-workload` pods were created:
+
----
$ oc -n openshift-user-workload-monitoring get pod
Expand Down
2 changes: 1 addition & 1 deletion modules/nw-egressnetworkpolicy-edit.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ To edit an existing egress network policy object for a project, complete the fol
$ oc get -n <project> egressnetworkpolicy
----

. Optionally, if you did not save a copy of the EgressNetworkPolicy object when you created the egress network firewall, enter the following command to create a copy.
. Optional: If you did not save a copy of the EgressNetworkPolicy object when you created the egress network firewall, enter the following command to create a copy.
+
----
$ oc get -n <project> \ <1>
Expand Down
20 changes: 10 additions & 10 deletions modules/nw-sriov-network-attachment.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -54,32 +54,32 @@ spec:
----
<1> Replace `<name>` with a name for the CR. The Operator will create a NetworkAttachmentDefinition CR with same name.
<2> Specify the namespace where the SR-IOV Operator is installed.
<3> Optional. Replace `<target_namespace>` with the namespace where the NetworkAttachmentDefinition CR will be created. The default value is `openshift-sriov-network-operator`.
<4> Optional. Replace `<ipam>` a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
<5> Optional. Replace `<vlan>` with a Virtual LAN (VLAN) ID for the additional network. The integer value must be from `0` to `4095`. The default value is `0`.
<3> Optional: Replace `<target_namespace>` with the namespace where the NetworkAttachmentDefinition CR will be created. The default value is `openshift-sriov-network-operator`.
<4> Optional: Replace `<ipam>` a configuration object for the ipam CNI plug-in as a YAML block scalar. The plug-in manages IP address assignment for the attachment definition.
<5> Optional: Replace `<vlan>` with a Virtual LAN (VLAN) ID for the additional network. The integer value must be from `0` to `4095`. The default value is `0`.
<6> Replace `<sriov_resource_name>` with the value for the `.spec.resourceName` parameter from the SriovNetworkNodePolicy CR that defines the SR-IOV hardware for this additional network.
<7> Optional. Replace `<link_state>` with the link state of Virtual Function (VF). Allowed value are `enable`, `disable` and `auto`.
<8> Optional. Replace `<max_tx_rate>` with a maximum transmission rate, in Mbps, for the VF.
<9> Optional. Replace `<min_tx_rate>` with a minimum transmission rate, in Mbps, for the VF. This value should always be less than or equal to Maximum transmission rate.
<7> Optional: Replace `<link_state>` with the link state of Virtual Function (VF). Allowed value are `enable`, `disable` and `auto`.
<8> Optional: Replace `<max_tx_rate>` with a maximum transmission rate, in Mbps, for the VF.
<9> Optional: Replace `<min_tx_rate>` with a minimum transmission rate, in Mbps, for the VF. This value should always be less than or equal to Maximum transmission rate.
+
[NOTE]
====
Intel NICs do not support the `minTxRate` parameter. For more information, see link:https://bugzilla.redhat.com/show_bug.cgi?id=1772847[BZ#1772847].
====
<10> Optional. Replace `<vlan_qos>` with an IEEE 802.1p priority level for the VF. The default value is `0`.
<11> Optional. Replace `<spoof_check>` with the spoof check mode of the VF. The allowed values are the strings `"on"` and `"off"`.
<10> Optional: Replace `<vlan_qos>` with an IEEE 802.1p priority level for the VF. The default value is `0`.
<11> Optional: Replace `<spoof_check>` with the spoof check mode of the VF. The allowed values are the strings `"on"` and `"off"`.
+
[IMPORTANT]
====
You must enclose the value you specify in quotes or the CR will be rejected by the SR-IOV Network Operator.
====
<12> Optional. Replace `<trust_vf>` with the trust mode of the VF. The allowed values are the strings `"on"` and `"off"`.
<12> Optional: Replace `<trust_vf>` with the trust mode of the VF. The allowed values are the strings `"on"` and `"off"`.
+
[IMPORTANT]
====
You must enclose the value you specify in quotes or the CR will be rejected by the SR-IOV Network Operator.
====
<13> Optional. Replace `<capabilities>` with the capabilities to configure for this network. You can specify `"{ "ips": true }"` to enable IP address support or `"{ "mac": true }"` to enable MAC address support.
<13> Optional: Replace `<capabilities>` with the capabilities to configure for this network. You can specify `"{ "ips": true }"` to enable IP address support or `"{ "mac": true }"` to enable MAC address support.

[start=2]
. Create the CR by running the following command:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can create a project using the *Developer* perspective, as follows:
image::odc_create_project.png[Create Project]

. In the *Create Project* dialog box, enter a unique name for the *Name* field. For example, enter `myproject` as the name of the project in the *Name* field.
. Optionally, add the *Display Name* and *Description* details for the Project.
. Optional: Add the *Display Name* and *Description* details for the Project.
. Click *Create*.
. Navigate to the *Advanced → Project Details* page to see the dashboard for your project.
. In the *Project* drop-down menu at the top of the screen, select *all projects* to list all of the projects in your cluster. If you have adequate permissions for a project, you can use the *Options* menu {kebab} to edit or delete the project.
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Create, build, and deploy an application on {product-title} using an existing co
image::odc_import_from_git.png[Import from Git]

. In the *Git* section, enter the Git repository URL for the codebase you want to use to create an application. For example, enter the URL of this sample Node.js application `\https://github.com/sclorg/nodejs-ex`. The URL is then validated.
. Optionally, you can click *Show Advanced Git Options* to add details such as:
. Optional: You can click *Show Advanced Git Options* to add details such as:

* *Git Reference* to point to code in a specific branch, tag, or commit to be used to build the application.
* *Context Dir* to specify the subdirectory for the application source code you want to use to build the application.
Expand Down Expand Up @@ -45,7 +45,7 @@ The *Knative Service* option is displayed in the *Import from git* form only if
====

. In the *Advanced Options* section, the *Create a route to the application* is selected by default so that you can access your application using a publicly available URL. You can clear the check box if you do not want to expose your application on a public route.
. Optionally, you can use the following advanced options to further customize your application:
. Optional: You can use the following advanced options to further customize your application:

Routing::
Click the *Routing* link to:
Expand Down