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.

Sign up for GitHub

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

Update 3.11 for openshift start / hyperkube changes #21268

Merged
merged 1 commit into from
May 28, 2020
Merged

Update 3.11 for openshift start / hyperkube changes #21268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
102 changes: 50 additions & 52 deletions install_config/master_node_configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,16 @@ toc::[]

== Customizing master and node configuration after installation

The `openshift start` command and its subcommands (`master` to launch a
xref:../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[master
server] and `node` to launch a
xref:../architecture/infrastructure_components/kubernetes_infrastructure.adoc#node[node
server]) take a limited set of arguments that are sufficient for launching
servers in a development or experimental environment.

However, these arguments are insufficient to describe and control the full set
of configuration and security options that are necessary in a production
environment. You must provide those options in the xref:../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[Master
host files], at *_/etc/origin/master/master-config.yaml_*
and the xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration maps]:

The `openshift start` command (for master servers) and `hyperkube` command (for
node servers) take a limited set of arguments that are sufficient for launching
servers in a development or experimental environment. However, these arguments
are insufficient to describe and control the full set of configuration and
security options that are necessary in a production environment.

You must provide these options in the
xref:../architecture/infrastructure_components/kubernetes_infrastructure.adoc#master[master configuration file],
at *_/etc/origin/master/master-config.yaml_*, and the
xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration maps].
Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you double confirm these other doc pages are desired? I just see these configuration file or configuration maps are in the same doc page ../install_config/master_node_configuration.html

These files define options including overriding the default plug-ins, connecting
to etcd, automatically creating service accounts, building image names,
customizing project requests, configuring volume plug-ins, and much more.
Expand Down Expand Up @@ -76,7 +73,7 @@ in the configuration files] themselves.
[NOTE]
====
To modify a node in your cluster, update the xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration maps] as needed.
Do not manually edit the `node-config.yaml` file.
Do not manually edit the *_node-config.yaml_* file.
====

endif::openshift-origin[]
Expand Down Expand Up @@ -290,7 +287,7 @@ xref:../install_config/master_node_configuration.adoc#node-configuration-files[n
[NOTE]
====
To modify a node in your cluster, update the xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration maps] as needed.
Do not manually edit the `node-config.yaml` file.
Do not manually edit the *_node-config.yaml_* file.
====

[[master-configuration-files]]
Expand Down Expand Up @@ -1069,7 +1066,7 @@ dnsConfig:

|`*MasterClientConnectionOverrides*`
|Provides overrides to the client connection used to connect to the master.
This parameter is not supported. To set QPS and burst values, see
This parameter is not supported. To set QPS and burst values, see
xref:#master-node-configuration-node-qps-burst[Setting Node QPS and Burst Values].

|`*MaxRequestsInFlight*`
Expand Down Expand Up @@ -1540,7 +1537,7 @@ include::scaling_performance/host_practices.adoc[tag=node-qps-burst]
| Parameter Name | Description

|`*kube-api-qps*`
|The QPS rate at which the Kubelet talks to the APIServer. The default is `20`.
|The QPS rate at which the Kubelet talks to the APIServer. The default is `20`.

|`*kube-api-burst*`
|The burst rate at which the Kubelet talks to the APIServer. The default is `40`.
Expand All @@ -1566,15 +1563,13 @@ starting with 1.9, the corruption issue is resolved and it is safe to switch to
parallel pulls.
====

====
[source,yaml]
----
kubeletArguments:
serialize-image-pulls:
- "false" <1>
----
<1> Change to true to disable parallel pulls. (This is the default config)
====
<1> Change to `true` to disable parallel pulls. This is the default configuration.

[[master-node-configuration-passwords-and-other-data]]
== Passwords and Other Sensitive Data
Expand All @@ -1588,31 +1583,27 @@ or in encrypted files.
.Environment Variable Example
[source,yaml]
----
...
bindPassword:
env: BIND_PASSWORD_ENV_VAR_NAME
----

.External File Example
[source,yaml]
----
...
bindPassword:
file: bindPassword.txt
----

.Encrypted External File Example
[source,yaml]
----
...
bindPassword:
file: bindPassword.encrypted
keyFile: bindPassword.key
----

To create the encrypted file and key file for the above example:

[options="nowrap"]
----
$ oc adm ca encrypt --genkey=bindPassword.key --out=bindPassword.encrypted
> Data to encrypt: B1ndPass0rd!
Expand Down Expand Up @@ -1650,23 +1641,20 @@ is recommended to not make them greater than these values.
To create configuration files for an all-in-one server (a master and a node on
the same host) in the specified directory:

[options="nowrap"]
----
$ openshift start --write-config=/openshift.local.config
----

To create a xref:master-configuration-files[master configuration file] and
other required files in the specified directory:

[options="nowrap"]
----
$ openshift start master --write-config=/openshift.local.config/master
----

To create a xref:node-configuration-files[node configuration file] and other
related files in the specified directory:

[options="nowrap"]
----
$ oc adm create-node-config \
--node-dir=/openshift.local.config/node-<node_hostname> \
Expand All @@ -1684,53 +1672,58 @@ comma-delimited list of every host name or IP address you want server
certificates to be valid for.

[[launching-servers-using-configuration-files]]

== Launching Servers Using Configuration Files
Once you have modified the master and/or node configuration files to your

After you have modified the master and node configuration files to your
specifications, you can use them when launching servers by specifying them as an
argument. Keep in mind that if you specify a configuration file, none of the
other command line options you pass are respected.
argument. If you specify a configuration file, none of the other command line
options you pass are respected.

[NOTE]
====
To modify a node in your cluster, update the xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration maps] as needed.
Do not manually edit the `node-config.yaml` file.
Do not manually edit the *_node-config.yaml_* file.
====

To launch an all-in-one server using a master configuration and a node
configuration file:

[options="nowrap"]
. Launch a master server using a master configuration file:
+
----
$ openshift start --master-config=/openshift.local.config/master/master-config.yaml --node-config=/openshift.local.config/node-<node_hostname>/node-config.yaml
$ openshift start master \
--config=/openshift.local.config/master/master-config.yaml
----

To launch a master server using a master configuration file:

[options="nowrap"]
. Start the network proxy and SDN plug-ins using a node configuration file and a
*_node.kubeconfig_* file:
+
----
$ openshift start master --config=/openshift.local.config/master/master-config.yaml
$ openshift start network \
--config=/openshift.local.config/node-<node_hostname>/node-config.yaml \
--kubeconfig=/openshift.local.config/node-<node_hostname>/node.kubeconfig
Comment on lines +1699 to +1701
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to request Networking QE @zhaozhanqi to double confirm for openshift start network

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks @xingxingxia LGTM

----

To launch a node server using a node configuration file:

[options="nowrap"]
. Launch a node server using a node configuration file:
+
----
$ openshift start node --config=/openshift.local.config/node-<node_hostname>/node-config.yaml
$ hyperkube kubelet \
$(/usr/bin/openshift-node-config \
--config=/openshift.local.config/node-<node_hostname>/node-config.yaml)
Comment on lines +1707 to +1709
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd like to request Node QE @weinliu @sunilcio to double confirm for the Launch a node server command.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@weinliu @sunilcio Are you able to take a look? Thanks!

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@adellape lgtm

----

[[master-node-view-logs]]
== Viewing Master and Node Logs

{product-title} collects log messages for debugging, using the `systemd-journald.service` for nodes and a script, called `master-logs`, for masters.
{product-title} collects log messages for debugging, using the
`systemd-journald.service` for nodes and a script, called `master-logs`, for
masters.

[NOTE]
====
The number of lines displayed in the web console is hard-coded at 5000 and cannot be changed.
To see the entire log, use the CLI.
The number of lines displayed in the web console is hard-coded at 5000 and
cannot be changed. To see the entire log, use the CLI.
====

The logging uses five log message severities based on Kubernetes logging conventions, as follows:
The logging uses five log message severities based on Kubernetes logging
conventions, as follows:

.Log Level Options
[cols="3a,6a",options="header"]
Expand Down Expand Up @@ -1784,11 +1777,17 @@ master-logs api api 2> file
[[master-node-config-logging-levels]]
=== Configuring Logging Levels

You can control which INFO messages are logged by setting the `DEBUG_LOGLEVEL` option in the in xref:../admin_guide/manage_nodes.adoc#modifying-nodes[node configuration files] or the */etc/origin/master/master.env* file. Configuring the logs to collect all messages can lead to large logs that are difficult to interpret and can take up excessive space. Only collect all messages when you need to debug your cluster.
You can control which INFO messages are logged by setting the `DEBUG_LOGLEVEL`
option in the *_/etc/origin/master/master.env_* file for the master or
*_/etc/sysconfig/atomic-openshift-node_* file for the nodes. Configuring the
logs to collect all messages can lead to large logs that are difficult to
interpret and can take up excessive space. Only collect all messages when you
need to debug your cluster.

[NOTE]
====
Messages with FATAL, ERROR, WARNING, and some INFO severities appear in the logs regardless of the log configuration.
Messages with FATAL, ERROR, WARNING, and some INFO severities appear in the logs
regardless of the log configuration.
====

To change the logging level:
Expand Down Expand Up @@ -1969,7 +1968,6 @@ W1022 15:12:00.256861 1 swagger.go:38] No API exists for predefined swagge
W1022 15:12:00.258106 1 swagger.go:38] No API exists for predefined swagger description /api/v1
----


[[master-node-config-restart-services]]
== Restarting master and node services

Expand Down