Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions docs/guides/ignite/rotate-auth/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Rotate Authentication Ignite
menu:
docs_{{ .version }}:
identifier: guides-ignite-rotate-auth
name: Rotate Authentication
parent: ignite-guides
weight: 46
menu_name: docs_{{ .version }}
---
48 changes: 48 additions & 0 deletions docs/guides/ignite/rotate-auth/overview.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
title: Rotate Authentication Overview
menu:
docs_{{ .version }}:
identifier: ignite-rotate-auth-overview
name: Overview
parent: guides-ignite-rotate-auth
weight: 5
menu_name: docs_{{ .version }}
section_menu_id: guides
---

> New to KubeDB? Please start [here](/docs/README.md).

# Rotate Authentication of Ignite

This guide will give an overview on how KubeDB Ops-manager operator Rotate Authentication configuration.

## Before You Begin

- You should be familiar with the following `KubeDB` concepts:
- [Ignite](/docs/guides/ignite/concepts/ignite/index.md)
- [IgniteOpsRequest](/docs/guides/ignite/concepts/opsrequest/index.md)

## How Rotate Ignite Authentication Configuration Process Works

The authentication rotation process for Ignite using KubeDB involves the following steps:

1. A user first creates an `Ignite` Custom Resource Object (CRO).

2. The `KubeDB Provisioner operator` continuously watches for `Ignite` CROs.

3. When the operator detects an `Ignite` CR, it provisions the required `PetSets`, along with related resources such as secrets, services, and other dependencies.

4. To initiate authentication rotation, the user creates an `IgniteOpsRequest` CR with the desired configuration.

5. The `KubeDB Ops-manager` operator watches for `IgniteOpsRequest` CRs.

6. Upon detecting an `IgniteOpsRequest`, the operator pauses the referenced `Ignite` object, ensuring that the Provisioner
operator does not perform any operations during the authentication rotation process.

7. The `Ops-manager` operator then updates the necessary configuration (such as credentials) based on the provided `IgniteOpsRequest` specification.

8. After applying the updated configuration, the operator restarts all `Ignite` Pods so they come up with the new authentication environment variables and settings.

9. Once the authentication rotation is completed successfully, the operator resumes the `Ignite` object, allowing the Provisioner operator to continue its usual operations.

In the next section, we will walk you through a step-by-step guide to rotating Ignite authentication using the `IgniteOpsRequest` CRD.
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
apiVersion: ops.kubedb.com/v1alpha1
kind: IgniteOpsRequest
metadata:
name: igops-rotate-auth-generated
namespace: demo
spec:
type: RotateAuth
databaseRef:
name: ignite-quickstart
timeout: 5m
apply: IfReady
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
apiVersion: ops.kubedb.com/v1alpha1
kind: IgniteOpsRequest
metadata:
name: igops-rotate-auth-user
namespace: demo
spec:
type: RotateAuth
databaseRef:
name: ignite-quickstart
authentication:
secretRef:
kind: Secret
name: ignite-quickstart-auth-user
timeout: 5m
apply: IfReady
Loading
Loading