setup_f5_k8s.sh script in the fusion-cloud-native repository provides deployment support for any Kubernetes platform, including on-premise, private cloud, public cloud, and hybrid platforms.
This script is used by the setup_f5_gke.sh, setup_f5_eks.sh, and setup_f5_aks.sh scripts, which provide additional platform-specific support for Google Kubernetes Engine (GKE), Amazon Elastic Kubernetes Service (EKS), and Azure Kubernetes Service (AKS).
See Fusion 5 Upgrades for more information about deployment instructions for:
- Natively supported deployments
- Other Kubernetes deployments
Fusion 5 Upgrades
Fusion 5 Upgrades
This guide describes how to perform Fusion 5 upgrades.Lucidworks recommends upgrading to the next minor version only. For example, you should upgrade from Fusion 5.6.1 to Fusion 5.7.1 before upgrading to Fusion 5.8.0.The general upgrade process is described in this article. However, the specific upgrade procedures may vary depending on your upgrade path. For the most accurate instructions, please refer to the upgrade article specific to your upgrade.Except for ZooKeeper, all K8s deployments and statefulsets use a ZooKeeper instances use You can also set the Lucidworks releases minor updates to individual services frequently. Pull in those upgrades using Helm at your discretion.How to upgrade Fusion
Before upgrading, be aware of changes by checking for Deprecations and Removals between versions.
General upgrade process
Fusion natively supports deployments on supported Kubernetes platforms, including AKS, EKS, and GKE.Fusion includes an upgrade script for AKS, EKS, and GKE. This script is not generated for other Kubernetes deployments.Upgrades differ from platform to platform. See below for more information about upgrading on your platform of choice.Whenever you upgrade Fusion, you must also update your remote connectors, if you are running any. You can download the latest files at V2 Connectors Downloads.Natively supported deployment upgrades
Fusion includes upgrade scripts for natively supported deployment types. To upgrade:
- Open the
<platform>_<cluster>_<release>_upgrade_fusion.shupgrade script file for editing. - Update the
CHART_VERSIONto your target Fusion version, and save your changes. - Run the
<platform>_<cluster>_<release>_upgrade_fusion.shscript. The<release>value is the same as your namespace, unless you overrode the default value using the-roption.
kubectl get pods to see the changes applied to your cluster. It may take several minutes to perform the upgrade, as new Docker images are pulled from DockerHub. To see the versions of running pods, do:Other Kubernetes deployment upgrades
To update an existing installation, do:RollingUpdate update policy:OnDelete to avoid changing critical stateful pods in the Fusion deployment. To apply changes to Zookeeper after performing the upgrade (uncommon), you need to manually delete the pods. For example:Delete one pod at a time. Verify the new pod is healthy and serving traffic, before deleting the next healthy pod.
updateStrategy under the zookeeper section in your "${MY_VALUES}" file:Upgrades with Helm v3
One of the most powerful features provided by Kubernetes and a cloud-native microservices architecture is the ability to do a rolling update on a live cluster. For example, Fusion 5 allows customers to upgrade from Fusion 5.1.0 to a later 5.x.y version on a live cluster with zero downtime or disruption of service.When Kubernetes performs a rolling update to an individual microservice, there is a mix of old and new services in the cluster. Requests from other services route to both versions.Lucidworks ensures all changes we make to our service do not break the API interface exposed to other services in the same minor release version (5.x). We also ensure that the stored configuration remains compatible in the same minor release version.
- Clone the fusion-cloud-native repo, if you haven’t already.
-
Locate the
setup_f5_<platform>.shscript that matches your Kubernetes platform. -
Run the script with the
--upgradeoption.
Helm upgrade script
Once you deploy a working cluster, use the upgrade script created by thecustomize_fusion_values.sh script. The upgrade script hard-codes the parameters and eases the need to remember which parameters to pass to the script. This is helpful when working with multiple K8s clusters. Make sure you check the script into version control alongside your custom values YAML files.Whenever you change the custom values YAML files for your cluster, you need to run the upgrade script to apply the changes. The script calls helm upgrade with the correct parameters and --values options.Considerations for on-prem deployments
Solr
Making changes to Solr’s memory settings after the initial installation, including changing the number of pods, is simple. Changing the size and type of disk, however, can be difficult. Before you begin, identify some basic sizing information for Solr:- Memory settings
- Disk size
- Disk type (e.g. SSD)
Docker images
Fusion’s public Docker images are hosted on DockerHub. If you do not allow your Kubernetes environment to pull images from DockerHub, you will need to copy the images to your internal registry. This can be a time-consuming process.Use a Private Repository for Docker Images
Use a Private Repository for Docker Images
This teaches you how to use a private repository to manage your Docker images. When you install or upgrade Fusion, you can specify the private repository instead of the public repository. If you’re deploying on-premises, you’ll need to set up on-premises private Docker registries.
-
Add a
values.shfile with the following. Some third-party dependencies might need service account level secrets if the chart doesn’t expose that field. You can use the Fusion install scripts to skip creating this file manually. -
Run the script:
./values.sh.
If you receive an error statingbash: ./values.sh: Permission denied, make the script executable:chmod +x values.shand run the script again:./values.sh.
The script creates a new file,<provider>_<cluster>_<namespace>_fusion_repository.yaml. The contents of the file resembles the following: -
Open the
<provider>_<cluster>_<namespace>_upgrade_fusion.shscript for editing. -
Update the
MY_VALUESvalues to refer to the<provider>_<cluster>_<namespace>_fusion_repository.yamlfile. -
Run the
<provider>_<cluster>_<namespace>_upgrade_fusion.shscript.
Helm charts
Helm is a package manager for Kubernetes that helps you install and manage applications on your Kubernetes cluster. We supply a Helm chart for the Fusion installation. If you are using Helm V2, thesetup_f5_k8s.sh script installs Helm’s Tiller component into your Kubernetes cluster with the cluster admin role. If you want to prevent the installation of Tiller, upgrade to Helm V3.
Nodes
For high availability, install Fusion on at least 3 nodes, ideally spread across 3 availability zones. This lets ZooKeeper keep its quorum and Solr keep serving requests if one node or zone goes down.Namespaces
Only one Fusion instance per namespace is supported, and all services for an instance must run in the same namespace. To run several Fusion instances in one cluster, such as development, test, and production, use a separate namespace for each.It is possible to install other apps alongside Fusion in the same namespace, if desired.
Resource sizing
CPU and memory requirements depend on your data volume, query load, and the Fusion features you use. Load test with production-like data and queries to determine the resources your environment needs. This applies to development and test environments as well as production.Pod resources
We recommend not placing resource limits on pods until you have run production-like workloads with your data and fully understand your resource requirements. The exception is Solr: setting resource requests and limits on Solr pods helps Kubernetes schedule them on nodes with enough capacity.Fusion gateway service
If you will be exposing the Fusion gateway service externally, you will need to consider your Kubernetes Ingress strategy:- How will you route to internal services, such as the gateway?
- Will you do TLS termination at the Ingress?
Deploying with a read-only root file system
Fusion 5.9.9 and later supports a read-only root file system to safeguard against unauthorized modifications. Most services operate efficiently in this mode, and for components that need write access, a separate writable mount is available using specific helm configurations. See Enable Read-Only Root File System for examples of how to configure this feature.Enable Read-Only Root File System
Enable Read-Only Root File System
This topic describes how to configure a read-only root file system for a Fusion deployment.
Read-only mode safeguards your file system against unauthorized changes, such as by malicious software or other attacks.
Enabling this feature entails configuring the Beginning with Fusion 5.9.10, all of Fusion’s services are designed to work with a read-only root file system, but some external services may require write access to the file system.
In that case, you can configure a read-only root file system and mount a separate writable file system for these services.The examples below show how to configure a read-only root file system for various Fusion services.With optional services:With optional services:With optional services:
readOnlyRootFilesystem attribute in the Fusion Helm chart.This feature is available starting in Fusion 5.9.9 and in all subsequent Fusion 5.9 releases.