Skip to content

Commit

Permalink
General cleanup, new intro text, and fix for Templates (template seem…
Browse files Browse the repository at this point in the history
…s to be a protected word) (#4)
  • Loading branch information
p5ntangle authored Oct 2, 2024
1 parent 3d930cc commit 5f24c4f
Show file tree
Hide file tree
Showing 6 changed files with 121 additions and 7 deletions.
75 changes: 75 additions & 0 deletions docs/assets/project-2a-lockup.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
14 changes: 14 additions & 0 deletions docs/glossary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Glossary

This glossary is a collection of terms related to Project 2A. In it we
attempt to clarify some of the unique terms and concepts we use or explain
more common ones that we feel may need a little clarity in the way we use
them.

### Beach Head Services
We use the term to refer to those kubernetes services that need to be installed
on a kubernetes cluster to make it actually useful, for example a ingress controller,
CNI and CSI. Whilst from the perspective of how they are deployed they are no different
from other kubernetes services we define them as distinct from the apps and services
deployed as part of the applictions.

34 changes: 29 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,38 @@

# Introduction

HMC is part of Mirantis Project 2A and is focused and developing a consistent
way to deploy and manage kubernetes clusters at scale. More informaiton can be
found [here](./introduction.md)
Mirantis Project 2A and is focused and developing a consistent way to deploy
and manage kubernetes clusters at scale. More information can be found [here](./introduction.md)

Project 2A was created to be a repeatable and secure way to leverage the tools
developed as part of the kubernetes ecosystem e.g. Cluster API without modifying
them, yet still being able to provide for the range of unique use cases we have
come across within enterprise IT environments.

## Main Premise

2A is built around the creation of a set of standardised templates that enable
easy and repeatable cluster deployments and life cycle management.

The main components of 2A include:

* Hybrid Multi Cluster Management(HMC)

Deployment and lifecycle managment of kubernetes clusters, including configuration, updates, and other CRUD operations.

* Cluster State Management (SMC)

Installation and lifecycle management of [beachead services](glossary.md#beach-head-services), policy, kubernetes api configurations and more.

* Observability (OBS)

Cluster and beach head services monitoring, events and log management.


## Supported Providers

## Providers
HMC leverages the Cluster API provider ecosystem, the following providers have
had templates created and validated
had templates created and validated, and more are in the works.


* [AWS](./aws/main.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/install/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export KUBECONFIG=<path-to-management-kubeconfig>
kubectl get template -n hmc-system -o go-template='{{ range .items }}{{ if eq .status.type "deployment" }}{{ .metadata.name }}{{ printf "\n" }}{{ end }}{{ end }}'
```

For details about the `Template system` in HMC, see [Templates system](../templates/main.md).
For details about the `Template system` in HMC, see [Templates system](../template/main.md).

If you want to deploy hostded control plate template, make sure to check additional notes on [Hosted control plane](../aws/hosted-control-plane.md).

Expand Down
File renamed without changes.
3 changes: 2 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ theme:
icon: material/brightness-4
name: Switch to light mode


icon: assets/mirantis-logo-inverted-horizontal-one-color.svg
logo: assets/mirantis-logo-inverted-horizontal-one-color.svg
favicon: assets/favicon.ico
Expand Down Expand Up @@ -62,7 +63,7 @@ nav:
- Installation:
- Quick Start: install/quick-start.md
- Installation Guide: install/installation.md
- Templates: templates/templates.md
- Templates: template/main.md
- Developer Guide: dev.md
- Provider Guides:
- AWS:
Expand Down

0 comments on commit 5f24c4f

Please sign in to comment.