1 Introduction
Important:
The software described in this documentation is either in Extended Support or Sustaining Support. See Oracle Open Source Support Policies for more information.
We recommend that you upgrade the software described by this documentation as soon as possible.
This document contains information about performing a quick installation of Oracle Cloud Native Environment and a Kubernetes cluster. The information in this document provides a fast installation method using default settings for the Oracle Cloud Native Environment platform and Kubernetes cluster.
If you are not familiar with Oracle Cloud Native Environment, you should first read about the architecture, components, and terminology definitions in Concepts.
The installation examples in this document use the Oracle Cloud Native Environment Platform CLI (olcnectl
) to set
up the hosts and their operating systems, and the Oracle Cloud Native Environment platform and Kubernetes cluster. The
installation options in this document offer a quick installation option, with commands that
set up the hosts and perform the installation automatically, instead of using the longer
procedure detailed in Getting Started.
The installation methods in this document require a minimum of options to be provided about your hosts and uses that information to set up each host. During the host set up, the appropriate network ports are opened, the software packages are installed, CA Certificates are created, the operating system services are configured, and finally, Kubernetes is deployed. This streamlines an installation of Oracle Cloud Native Environment to get you up and running quickly.
You can also perform more complex deployments, setting your own security options and installing optional modules using an Oracle Cloud Native Environment configuration file. Examples of using a configuration file are also included in this document.
Hosts
To start the installation, you need to set up a host with the Platform CLI
(olcnectl
). In this document, this installation host is referred to as
the operator node.
You also need to set up the hosts you want to include in the Kubernetes cluster (the Kubernetes control plane and worker nodes).
SSH key-based authentication should be set up between the installation host (operator node) and the hosts to be included in the Kubernetes cluster.
You may also need to set up a load balancer if you want to use an external load balancer for High Availability of the Kubernetes control plane.
Platform CLI
The Platform CLI command, olcnectl provision
, is the command to use to
perform a quick installation, and is run from the operator node. This command sets up the
Kubernetes nodes, configures the node operating systems, creates CA Certificates for the
Kubernetes nodes, installs the software packages, and creates a Kubernetes cluster.
The installation examples in this document show you how to use the olcnectl
provision
command to perform an installation. The steps performed by this command
are:
-
Generate CA Certificates.
-
Copy the CA Certificates to each node.
-
Set up the operating system on each node, including opening network ports.
-
Install the Oracle Cloud Native Environment software packages on each node.
-
Start the Oracle Cloud Native Environment platform services (Platform API Server and Platform Agent).
-
Create an Oracle Cloud Native Environment environment.
-
Create, validate and install a Kubernetes module, which creates the Kubernetes cluster.
-
Set up the Platform CLI certificates to
~/.olcne
on the operator node to access the environment using theolcnectl
command. -
Install optional modules if using a configuration file.
If you use all the defaults when using the olcnectl provision
command, you
install the most straight-forward installation option, using private CA Certificates. It is
recommended for a production environment that you use your own CA Certificates.
For information on the syntax options for the olcnectl provision
command,
see Platform Command-Line Interface.
Complex Deployments
You can perform more complex installations by writing an Oracle Cloud Native Environment configuration file and passing the file to
the olcnectl provision
command using the --config-file
option. A configuration file allows you to specify security options such as the SELinux
setting on the nodes, the location of pre-generated CA Certificates and whether to deploy
the Kubernetes externalIPs
service.
If you use a configuration file, you can also use the olcnectl provision
command to install optional Oracle Cloud Native Environment modules, for
example, the Istio module, or the Oracle Cloud Infrastructure Cloud Controller Manager
module.
If you want an installation that uses Vault to generate and authenticate the certificates for the Kubernetes nodes, you should use the full installation steps outlined in Getting Started.
For information on writing a configuration file, see Platform Command-Line Interface.
Install Examples
A number of different installation types are provided to help you get up and running quickly. Choose the option that best matches your deployment type and use the installation example as a guide to get you started with your own installation.
Table 1-1 Installation Examples
Install Type | Bare Metal or Virtual Machine | Oracle Cloud Infrastructure |
---|---|---|
Platform and Kubernetes |
||
Platform and Kubernetes HA |
||
Platform and Kubernetes with Optional Modules |
Quick HA Install using Configuration File on Oracle Cloud Infrastructure |