OSDU Deployment Framework
Creates a fully functional OSDU instance.
NOTE
Using a release version of OSDU is strongly recommended. Latest release is availabe here.
Current implementations:
- Google Cloud - Terraform-based.
- Baremetal Implementation - Helm-based.
Below you find OSDU installation guides for master branch on Google Cloud or Baremetal environment.
The code is not production-ready and is provided as-is.
Infrastructure dependencies for Baremetal implementation don't support upgrade from previous versions.
masterbranch version is under continuous development and may not be stable.
Google Cloud
If you need an OSDU instance within a single Google Cloud project, you can use Terraform module for it.
- Instructions: instructions for simple installation
- Terraform module: module
The terraform module is responsible for managing all infrastructure dependencies. It also creates and configures custom values for OSDU Services installation via helm and can apply them.
However, some manual steps for initial configuration must be performed beforehand.
Baremetal Implementation
Depending on your environment and the purpose for which you plan to use the Baremetal Implementation, you may consider several types of installation described below.
All examples are based on OSDU Baremetal helm chart.
Baremetal environment
OSDU instance with default values
If you plan an OSDU instance on your environment, you can start from the original README of OSDU helm chart.
Also, to minimize required configuration steps, a simple installation example can be used. It uses a lot of default values and requires configuration only for a small number of parameters.
- Example directory
- Original OSDU helm chart
OSDU instance with custom versions of images or helm charts
You can start from the original README of OSDU helm chart.
If there is a need to install OSDU instance with custom images or helm charts for Services, you can do it with the help of an example.
Possible use-cases:
- You installed OSDU instance with release version
0.18, and you need to deploy specific OSDU Service(s) with a new (or a previous) image version (with some fixes, for example) - You installed OSDU instance with release version
0.18, and you need to deploy specific OSDU Service(s) with a new (or a previous) helm chart version (with some fixes, for example)
More details are below:
- Example directory
- Original OSDU helm chart
Baremetal
If you plan an OSDU instance on a Kubernetes cluster (baremetal), you can start from the original README of OSDU Baremetal helm chart.
You can use a simple example of how to configure the Kubernetes cluster and install the helm chart. It is based on standard Kubernetes installation - 1 master node and 3 worker nodes as the underlying infrastructure.
- Example directory
- Original OSDU Baremetal helm chart
GoogleCloud GKE with Istio
If you plan an OSDU instance on a Kubernetes cluster in GoogleCloud, you can start from the original README of OSDU Baremetal helm chart.
You can use a simple example of how to create the Kubernetes cluster, deploy Istio and install the helm chart. It is based on standard Kubernetes cluster with 2 nodes.
- Example directory
- Original OSDU Baremetal helm chart
Minikube
If you plan an OSDU instance on a local machine, you may consider using Minikube as the underlying infrastructure.
Start from the original README of OSDU Baremetal helm chart.
And you can use a simple example of how to configure Minikube and install the helm chart.
- Example directory
- Original OSDU Baremetal helm chart
- Tested with release version
0.22.2baremetal minikube
Docker Desktop
If you plan an OSDU instance on a local machine with a minimum of configuration steps, you may consider using Docker Desktop as the underlying infrastructure.
Start from the original README of OSDU Baremetal helm chart.
And you can use a simple example of how to configure Docker Desktop and install the helm chart.
- Example directory
- Original OSDU Baremetal helm chart
Offline installation
If you plan an OSDU instance on an offline Kubernetes cluster (Baremetal) with no internet connection, you can follow the example that describes the specifics of installing original OSDU Baremetal helm chart in the offline environment.
You can use a simple example of how to configure the Kubernetes Baremetal cluster and install the helm chart. It is based on standard Kubernetes installation - 1 master node and 3 worker nodes as the underlying infrastructure.
- Offline installation example directory
- Original OSDU Baremetal helm chart
- Baremetal cluster configuration example
Offline installation with access to Google
If you plan an OSDU instance on an offline Kubernetes cluster (Baremetal) with a connection to Google services, you can follow the example that describes the specifics of installing original OSDU Baremetal helm chart in the offline environment with access to Google.
You can use a simple example of how to configure the Kubernetes Baremetal cluster and install the helm chart. It is based on standard Kubernetes installation - 1 master node and 3 worker nodes as the underlying infrastructure.
- Offline installation with Google access example directory
- Original OSDU Baremetal helm chart
- Baremetal cluster configuration example