Skip to content

Commit

Permalink
feat: add azure into v2.7 (#836)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrsimonemms authored Nov 27, 2024
1 parent 18784d0 commit 80ff6d1
Show file tree
Hide file tree
Showing 25 changed files with 417 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -131,9 +131,9 @@ const config = {
label: 'AWS',
},
{
type: 'docsVersion',
type: 'docSidebar',
position: 'left',
to: '/next/azure/overview',
sidebarId: 'azure',
label: 'Azure',
},
{
Expand Down
9 changes: 9 additions & 0 deletions versioned_docs/version-2.7/azure/credits.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Credits
description: credit to all the awesome open source projects
image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
---

import CommonCredits from "../common/credits.mdx";

<CommonCredits />
12 changes: 12 additions & 0 deletions versioned_docs/version-2.7/azure/deprovision.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
hide_title: true
sidebar_label: Deprovision
description: how to deprovision your kubefirst platform
keywords:
- aws
image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
---

import Deprovision from '../common/deprovision.mdx';

<Deprovision />
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/argocd.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Argo CD
sidebar_position: 1
---

# Azure - Argo CD

import ExploreArgocd from "../../common/argocd.mdx";

<ExploreArgocd cloud="Azure" />
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/gitops.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: GitOps
sidebar_position: 2
---

import ExploreGitOps from "../../common/gitops.mdx";

# Azure - GitOps

<ExploreGitOps />
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/metaphor.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Metaphor
sidebar_position: 3
---

import ExploreMetaphor from "../../common/metaphor.mdx";

# Azure - Metaphor

<ExploreMetaphor/>
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/telemetry.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Telemetry
sidebar_position: 7
---

import ExploreTelemetry from "../../common/telemetry.mdx";

# Azure - Telemetry

<ExploreTelemetry/>
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/terraform.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Terraform & Atlantis
sidebar_position: 4
---

import ExploreTerraform from "../../common/terraform.mdx";

# Azure - Terraform & Atlantis

<ExploreTerraform/>
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/user-creation.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Users Management
sidebar_position: 5
---

import UserCreation from "../../common/users.mdx";

# Azure - Users Management

<UserCreation cloud="azure" />
10 changes: 10 additions & 0 deletions versioned_docs/version-2.7/azure/explore/vault.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Vault
sidebar_position: 6
---

import ExploreVault from "../../common/vault.mdx";

# Azure - Vault

<ExploreVault/>
17 changes: 17 additions & 0 deletions versioned_docs/version-2.7/azure/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: FAQ
description: frequently asked quesitons about the kubefirst platform
image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
---

import FAQ from "../common/faq.mdx";

<FAQ cloud="Azure" />

## Azure

### What authentication methods do you support?

Currently, the only supported authentication method is a service principal with a client secret. Support for service principals with certificates is likely to be supported in the future. Please see [konstructio/kubefirst#2319](https://github.com/konstructio/kubefirst/issues/2319) for details and up-vote if you depend on this feature to use Kubefirst.

There are no plans to support authentication without a service principal.
14 changes: 14 additions & 0 deletions versioned_docs/version-2.7/azure/gitops-catalog.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
hide_title: true
sidebar_label: GitOps Catalog
description: using the kubefirst gitops catalog
keywords:
- aws
image: 'https://kubefirst.konstruct.io/docs/img/kubefirst.svg'
---

import GitOpsCatalog from '../common/gitops-catalog.mdx';

# Azure - GitOps Catalog

<GitOpsCatalog />
59 changes: 59 additions & 0 deletions versioned_docs/version-2.7/azure/overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
---
sidebar_label: Overview
sidebar_position: 1
description: an overview of kubefirst on an Azure kubernetes cluster
image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
---

import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
import styles from "../stylesheets/tabs.module.css";
import CommonProvisionProcess from "../common/partials/common/_provision-process.mdx";
import GitHubOverview from '../azure/partials/github/_overview.mdx';
import GitLabOverview from '../azure/partials/gitlab/_overview.mdx';
import KnownLimitations from "../common/known-limitations.mdx";
import AzureLogo from '../img/azure/logo.svg';
import GitHubLogo from '../common/components/GitHubLogo.jsx'
import GitLabLogo from '../common/components/GitLabLogo.jsx'

<div class="cloud_logo">
<AzureLogo width="200px" alt="Azure Logo" />
</div>

# Overview

:::caution

Azure is in beta. Use at your own risk.

:::

The Azure provisioning process will:
<CommonProvisionProcess firstitem="Create a Kubernetes management cluster in the Azure cloud."/>

<Tabs groupId="git_provider" defaultValue="github" queryString>
<TabItem attributes={{ className: styles.github }} value="github" label={ <GitHubLogo /> }>

![Installation Diagram](../img/azure/github/installation-diagram-light.svg#light-mode)![Installation Diagram](../img/azure/github/installation-diagram-dark.svg#dark-mode)

## Applications
<GitHubOverview />

</TabItem>
<TabItem value="gitlab" attributes={{ className: styles.gitlab }} label={ <GitLabLogo /> }>

![Installation Diagram](../img/azure/gitlab/installation-diagram-light.svg#light-mode)![Installation Diagram](../img/azure/gitlab/installation-diagram-dark.svg#dark-mode)

## Applications
<GitLabOverview />
</TabItem>
</Tabs>

## Known Limitations

<KnownLimitations />

## Azure Specific

- Azure is still in beta, but should be usable in production
- Workload clusters are not available yet
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The `dns-azure-resource-group` is only required if using Azure as your DNS provider. This is the name of the resource group where the [DNS Zone](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records) resource is provisioned.
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```shell
az aks get-credentials --resource-group <my-cluster> --name <my-cluster>
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
```shell
brew install azure-cli
```

More information in the [Azure documentation](https://learn.microsoft.com/en-us/cli/azure/install-azure-cli).
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### Azure Prerequisites

For kubefirst to be able to provision your Azure cloud resources:

- An [Azure account](https://portal.azure.com) in which you are an account owner.
- A publicly routable [DNS zone](https://learn.microsoft.com/en-us/azure/dns/dns-zones-records).
- A [Microsoft Entra app and service principal](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal) with `Owner` permissions on your subscription.

#### Environment variables

Azure authentication requires the following environment variables to be set:

| Variable | Description |
| --- | --- |
| `ARM_CLIENT_ID` | The unique ID for your [service principal](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#sign-in-to-the-application) |
| `ARM_CLIENT_SECRET` | The secret for your [service principal](https://learn.microsoft.com/en-us/entra/identity-platform/howto-create-service-principal-portal#option-3-create-a-new-client-secret) |
| `ARM_SUBSCRIPTION_ID` | The unique ID for your [Azure subscription](https://learn.microsoft.com/en-us/azure/azure-portal/get-subscription-tenant-id#find-your-azure-subscription) |
| `ARM_TENANT_ID` | The unique ID for your [Microsoft Entra tenant](https://learn.microsoft.com/en-us/azure/azure-portal/get-subscription-tenant-id#find-your-microsoft-entra-tenant) |
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
import DNSResourceGroup from "../../partials/common/_dns-resource-group.mdx"

## Create your new kubefirst cluster

Adjust the following command with your GitHub and Azure tokens in addition to the appropriate values for your new platform.

```shell
export GITHUB_TOKEN=ghp_xxxxxxxxxxxxxxxx
export ARM_CLIENT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_SUBSCRIPTION_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_TENANT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

kubefirst beta azure create \
--alerts-email [email protected] \
--github-org your-github-org \
--domain-name your-domain.io \
--cluster-name kubefirst \
--dns-azure-resource-group <dns-resource-group>
```

<DNSResourceGroup />
<CloudflareDNS />
16 changes: 16 additions & 0 deletions versioned_docs/version-2.7/azure/partials/github/_overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
`kubefirst beta azure create` provisions a local [Azure](https://azure.microsoft.com) Kubernetes cluster to host your cloud native environment locally.

Your Azure cluster will include:

| Application | Description |
|---------------------------------|-----------------------------------------------------------------------------|
| Argo CD | GitOps Continuous Delivery |
| Argo Workflows | Application Continuous Integration |
| Atlantis | Terraform Workflow Automation |
| cert-manager | Certificate Automation Utility |
| ChartMuseum | Helm Chart Registry |
| External Secrets Operators | Syncs Kubernetes secrets with Vault secrets |
| GitHub Action Runner Controller | GitHub Self-Hosted CI Executor |
| HashiCorp Vault | Secrets Management |
| Metaphor | (development, staging, production) instance of sample Next.js app |
| Ingress Nginx | Ingress Controller |
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import CloudflareDNS from "../../../common/partials/common/_cloudflare-dns.mdx";
import DNSResourceGroup from "../../partials/common/_dns-resource-group.mdx"

## Create your new kubefirst cluster

Adjust the following command with your GitHub and Azure tokens in addition to the appropriate values for your new platform.

```shell
export GITLAB_TOKEN=glpat-xxxxxxxxxxxxxxxx
export ARM_CLIENT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_CLIENT_SECRET=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_SUBSCRIPTION_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
export ARM_TENANT_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

kubefirst beta azure create \
--alerts-email [email protected] \
--git-provider gitlab \
--gitlab-group your-fully-qualified-gitlab-group/or-sub-group \
--domain-name your-domain.io \
--cluster-name kubefirst \
--dns-azure-resource-group <dns-resource-group>
```

<DNSResourceGroup />
<CloudflareDNS />
16 changes: 16 additions & 0 deletions versioned_docs/version-2.7/azure/partials/gitlab/_overview.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
`kubefirst beta azure create` provisions a local [Azure](https://azure.microsoft.com) Kubernetes cluster to host your cloud native environment locally.

Your Azure cluster will include:

| Application | Description |
|---------------------------------|-----------------------------------------------------------------------------|
| Argo CD | GitOps Continuous Delivery |
| Argo Workflows | Application Continuous Integration |
| Atlantis | Terraform Workflow Automation |
| cert-manager | Certificate Automation Utility |
| ChartMuseum | Helm Chart Registry |
| External Secrets Operators | Syncs Kubernetes secrets with Vault secrets |
| GitLab Runner | GitLab Self-Hosted CI Executor |
| HashiCorp Vault | Secrets Management |
| Metaphor | (development, staging, production) instance of sample Next.js app |
| Ingress Nginx | Ingress Controller |
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Cluster Management
sidebar_position: 3
description: cluster creation and lifecycle management powered by gitops
image: "https://kubefirst.konstruct.io/docs/img/kubefirst.svg"
---

import CLUSTERS from "../../common/clusters.mdx";

<CLUSTERS />
Loading

0 comments on commit 80ff6d1

Please sign in to comment.