Skip to content
This repository has been archived by the owner on Feb 9, 2022. It is now read-only.

Commit

Permalink
docs: add BKPR v1.2 migration guide
Browse files Browse the repository at this point in the history
Kibana index needs to be reindexed in order to migrate to Kibana 6

Signed-off-by: Sameer Naik <sameer@bitnami.com>
  • Loading branch information
Sameer Naik committed Feb 18, 2019
1 parent 9aba23e commit 11b666c
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 0 deletions.
52 changes: 52 additions & 0 deletions docs/migration-guides/bkpr-1.2-migration-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Migration Guide: Moving to BKPR v1.2

This document is intended towards users who want upgrade their Kubernetes clusters to BKPR v1.2 from BKPR v1.1 and below. The document will assist in migrating a Kubernetes cluster to BKPR v1.2. Be sure to read this guide in its entirety before performing the upgrade.

## Requirements

* Kubernetes cluster with BKPR v1.1 or below

## Overview

Making the move to BKPR v1.2 is a simple process that involves the following steps:

1. Migrate Kibana index to 6.0
1. Upgrade to BKPR v1.2

## Migrate Kibana index to 6.0

In BPKR v1.2, Elasticsearch and Kibana have been upgraded to version 6. Before upgrading to BKPR v1.2, your Kibana index needs to be reindexed in order to migrate to Kibana 6.

Changes will be made to your Kibana index, it is recommended that you [backup your Kibana index](https://www.elastic.co/guide/en/elasticsearch/reference/5.6/modules-snapshots.html) before proceeding.

The [official Kibana 6 index migration guide](https://www.elastic.co/guide/en/kibana/6.0/migrating-6.0-index.html#migrating-6.0-index) lists the steps to follow for migrating the Kibana index to the 6.0 format.

> **Note**:
>
> To perform the migration with zero downtime, add `"index.format": 6` and `"index.mapping.single_type": true` under `settings` in the second step of the Kibana index migration guide.
Access the Kibana console editor by visiting `https://kibana.my-domain.com/app/kibana#/dev_tools/console`* and execute the steps listed in the [Kibana index migration guide](https://www.elastic.co/guide/en/kibana/6.0/migrating-6.0-index.html#migrating-6.0-index).

_*Replace `my-domain.com` in the above URL with the DNS suffix specified while installing BKPR_

## Upgrade to BKPR v1.2

After the Kibana index has been migrated to the 6.0 format, you can upgrade BKPR to v1.2 with the following steps:

### Step 1: Update the installer

Follow the [installation guide](install.md) to update the BKPR installer binary to the latest release of BKPR v1.2.

### Step 2: Edit `kubeprod-manifest.jsonnet`

Edit the `kubeprod-manifest.jsonnet` file and update the `import` statement to point to the location of the manifests from the downloaded BKPR release.

### Step 3: Perform the upgrade

Re-run the `kubeprod install` command in the directory containing the existing `kubeprod-autogen.json` and updated `kubeprod-manifest.jsonnet` files.

## Resources

* [Elasticsearch 6.0 Release Notes](https://www.elastic.co/guide/en/elasticsearch/reference/6.0/es-release-notes.html)
* [Elasticsearch 6.0 Breaking Changes](https://www.elastic.co/guide/en/elasticsearch/reference/6.0/breaking-changes-6.0.html)
* [Migrating Kibana index to 6.0](https://www.elastic.co/guide/en/kibana/6.0/migrating-6.0-index.html)
4 changes: 4 additions & 0 deletions jenkins/Release_Notes.md.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,9 @@ Follow the [installation guide](https://github.com/bitnami/kube-prod-runtime/blo
- [Azure Kubernetes Service (AKS)](https://github.com/bitnami/kube-prod-runtime/blob/master/docs/quickstart-aks.md)
- [Google Kubernetes Engine (GKE)](https://github.com/bitnami/kube-prod-runtime/blob/master/docs/quickstart-gke.md)

# Migration Guide

- [BKPR v1.2 Migration Guide](https://github.com/bitnami/kube-prod-runtime/blob/master/docs/migration-guides/bkpr-1.2-migration-guide.md)

# Changelog

0 comments on commit 11b666c

Please sign in to comment.