1. Installation for Release 1.9
  2. Configuring Services

6 Configuring Services

This chapter contains information about any configuration options for Oracle Cloud Native Environment, including configuring the Platform API Server and Platform Agent services.

Configuring the Platform API Server

The Platform API Server runs as a Systemd service, named olcne-api-server. You can get logs for this service using: 

sudo journalctl -u olcne-api-server

By default, the service logs information level messages. You can change this to log debug level messages using the OLCNE_DEBUG environment variable or a Systemd drop in file.

If the environment variable is set to OLCNE_DEBUG=0, the logging level is set to information messages. Setting OLCNE_DEBUG=1 sets the logging level to debug messages, for example: 

export OLCNE_DEBUG=1

You can also set this as a Systemd drop in file. Edit the /etc/systemd/system/olcne-api-server.service.d/10-auth.conf file and change the OLCNE_DEBUG entry. For example: 

[Service]
Environment="VAULT_SKIP_VERIFY=false"
Environment="OLCNE_DEBUG=1"
Environment="OLCNE_AGENT_ARGS= --secret-manager-type 'file' "
Environment="OLCNE_TLS=  "
ExecStart=
ExecStart=/usr/libexec/olcne-api-server -i /etc/olcne/modules $OLCNE_AGENT_ARGS $OLCNE_TLS
RestartSec=5

You can change some Platform API Server settings by editing the Systemd service unit file so that the binary is invoked to use extra options.

olcne-api-server options:

  • [-p|--port] port_number

    Specifies the port that the Platform API Server binds to. Defaults to 8091 if unspecified.

  • [-i|--installables] installables_path

    Specifies the path to the directory of installable modules. Defaults to /etc/olcne/modules.

  • [-x|--insecure]

    Allows the gRPC server to accept clients that don't securely establish their identity.

To reconfigure the Platform API Server to use any of these options, you can edit the Systemd unit file at /usr/lib/systemd/system/olcne-api-server.service and append the option to the ExecStart line. For example: 

[Unit]
Description=Platform API Server for Oracle Cloud Native Environments
Wants=network.target
After=network.target

[Service]
ExecStart=/usr/libexec/olcne-api-server -i /etc/olcne/modules --port 9083
WorkingDirectory=/var/olcne
User=olcne
Group=olcne
Restart=on-failure

[Install]
WantedBy=multi-user.target

If you edit the Systemd unit or drop in file, you must run the following commands for the changes to take effect: 

sudo systemctl daemon-reload
sudo systemctl restart olcne-api-server.service

Note:

If you change the port value for this service, take this into account for all other instructions provided in the documentation.

Configuring the Platform Agent

The Platform Agent runs as a Systemd service, named olcne-agent. You can get logs for this service using: 

sudo journalctl -u olcne-agent

By default, the service logs information level messages. You can change this to log debug level messages using the OLCNE_DEBUG environment variable or a Systemd drop in file.

If the environment variable is set to OLCNE_DEBUG=0, the logging level is set to information messages. Setting OLCNE_DEBUG=1 sets the logging level to debug messages, for example: 

export OLCNE_DEBUG=1

You can also set this as a Systemd drop in file. Edit the /etc/systemd/system/olcne-agent.service.d/10-auth.conf file and change the OLCNE_DEBUG entry. For example: 

[Service]
Environment="VAULT_SKIP_VERIFY=false"
Environment="OLCNE_DEBUG=1"
Environment="OLCNE_AGENT_ARGS= --secret-manager-type 'file' "
Environment="OLCNE_TLS=  "
ExecStart=
ExecStart=/usr/libexec/olcne-agent  $OLCNE_AGENT_ARGS $OLCNE_TLS
RestartSec=5

You can change some Platform Agent settings by editing the Systemd service unit file so that the binary is invoked to use extra options.

olcne-agent options:

  • [-p|--port] port-number

    Specifies the port that the Platform Agent service binds to. Defaults to 8090 if unspecified.

  • [-x|--insecure]

    Allows the gRPC server to accept clients that don't securely establish their identity.

To reconfigure the Platform Agent to use any of these options, you can edit the Systemd unit file at /usr/lib/systemd/system/olcne-agent.service and append the option to the ExecStart line.

If you edit the Systemd unit or drop in file, you must run the following commands for the changes to take effect: 

sudo systemctl daemon-reload
sudo systemctl restart olcne-agent.service

Note:

If you change the port value for this service, take this into account for all other instructions provided in the documentation.