diff --git a/.gitignore b/.gitignore index d2670ed72..fe4586097 100644 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,6 @@ test/e2e/*.log # Vendoring directory vendor + +# mkdocs folder +mkdocs diff --git a/docs/assets/favicon.ico b/docs/assets/favicon.ico new file mode 100644 index 000000000..3d4fcc6d8 Binary files /dev/null and b/docs/assets/favicon.ico differ diff --git a/docs/assets/mirantis-logo-inverted-horizontal-one-color.svg b/docs/assets/mirantis-logo-inverted-horizontal-one-color.svg new file mode 100644 index 000000000..c1f56f818 --- /dev/null +++ b/docs/assets/mirantis-logo-inverted-horizontal-one-color.svg @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..04f5b8021 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,28 @@ +# Welcome to HMC Docs + + +# 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) + + +## Providers +HMC leverages the Cluster API provider ecosystem, the following providers have +had templates created and validated + + + * [AWS](./aws/main.md) + * [Azure](./azure/main.md) + * [Vsphere](./vsphere/main.md) + + + + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + \ No newline at end of file diff --git a/docs/introduction.md b/docs/introduction.md new file mode 100644 index 000000000..b647609a1 --- /dev/null +++ b/docs/introduction.md @@ -0,0 +1,19 @@ +# Project Overview + +```mermaid +--- +title: HMC Overview +--- +erDiagram + USER ||--o{ HMC : uses + USER ||--o{ Template : assigns + Template ||--o{ HMC : "used by" + HMC ||--o{ CAPI : connects + CAPI ||--|{ CAPV : provider + CAPI ||--|{ CAPA : provider + CAPI ||--|{ CAPZ : provider + CAPI ||--|{ K0smotron : Bootstrap + K0smotron |o..o| CAPV : uses + K0smotron |o..o| CAPA : uses + K0smotron |o..o| CAPZ : uses +``` \ No newline at end of file diff --git a/docs/mk-docs-setup.md b/docs/mk-docs-setup.md new file mode 100644 index 000000000..998a4d409 --- /dev/null +++ b/docs/mk-docs-setup.md @@ -0,0 +1,42 @@ +# HMC MKdocs Setup + +## Project layout + + mkdocs.yml # The configuration file. + docs/ + index.md # The documentation homepage. + stylesheets # CSS stylesheets to control look and feel + assets # Images and other served material + ... # Other markdown pages, images and other files. + + +## Setting up MKdocs and dependancies + +1. Setup python Virtual Environment + + `python3 -m venv ./mkdocs` + `source ./mkdocs/bin/activate` + +2. Install MkDocs + + `pip install mkdocs` + +3. Install plugins + + `pip install mkdocs-mermaid2-plugin` + + `pip install mkdocs-material` + +## Run MKdocs for dev + +* `mkdocs serve` - Start the live-reloading docs server. + +For full documentation visit [mkdocs.org](https://www.mkdocs.org). + +## MKdocs Commands + +* `mkdocs new [dir-name]` - Create a new project. +* `mkdocs serve` - Start the live-reloading docs server. +* `mkdocs build` - Build the documentation site. +* `mkdocs -h` - Print help message and exit. + diff --git a/docs/quick-start.md b/docs/quick-start.md new file mode 100644 index 000000000..39e61326c --- /dev/null +++ b/docs/quick-start.md @@ -0,0 +1,16 @@ +# Mirantis Hybrid Cloud Platform + +## Installation + +### TLDR + + kubectl apply -f https://github.com/Mirantis/hmc/releases/download/v0.0.1/install.yaml + +or install using `helm` + + helm install hmc oci://ghcr.io/mirantis/hmc/charts/hmc --version v0.0.1 -n hmc-system --create-namespace + + +> Note: The HMC installation using Kubernetes manifests does not allow customization of the deployment. To apply a custom HMC configuration, install HMC using the Helm chart. +> deployment. If the custom HMC configuration should be applied, install HMC using +> the Helm chart. \ No newline at end of file diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 000000000..e65d3c741 --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,39 @@ +/** + * Copyright 2024 + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +:root { + --md-primary-fg-color: #4ba0f3; + --md-primary-fg-color--light: #4ba0f3; + --md-primary-fg-color--dark: #4ba0f3; + } + .md-header__button.md-logo img { + height: fit-content; /* Adjust the size as needed */ + } + .md-header__title { + font-size: 1.1rem; + } + .md-nav { + font-size: .8rem; + font-weight: 800; + line-height: 1.3; + } + .md-typeset h1, .md-typeset h2 { + font-weight: 500; + letter-spacing: -.01em; + } + .md-typeset h3 { + font-weight: 500; +} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 000000000..7e34a1d38 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,53 @@ +site_name: HMC +site_author: Mirantis +docs_dir: ./docs +repo_name: GitHub +repo_url: https://github.com/mirantis/hmc +copyright: + '© 2005 - 2024 Mirantis, Inc. All rights reserved. “Mirantis” and “FUEL” are registered trademarks of Mirantis, Inc. All other trademarks are the property of their respective owners.' +nav: + - Home: index.md + - Introduction: introduction.md + - Quick Start: quick-start.md + - Developer Guide: dev.md + + + +theme: + name: "material" + font: + text: overpass + code: Roboto Mono + palette: + # Palette toggle for light mode + - scheme: default + primary: custom + toggle: + icon: material/brightness-7 + name: Switch to dark mode + + # Palette toggle for dark mode + - scheme: slate + primary: custom + toggle: + 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 + + search: true + search_index_only: true + features: + - toc.autohide + - search.suggest + - search.highlight + +extra_css: + - stylesheets/extra.css + +plugins: + - search + - mermaid2 +