commit e433665030a1811591ebd73d3cf529a2dd527649 Author: Administrator Date: Thu Sep 1 11:46:09 2022 -0500 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..b352f89 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +site/ +docs/crucible.md +docs/topomojo.md diff --git a/docs/assets/cmu-sei-unitmark.png b/docs/assets/cmu-sei-unitmark.png new file mode 100644 index 0000000..80404dd Binary files /dev/null and b/docs/assets/cmu-sei-unitmark.png differ diff --git a/docs/assets/esxi-disk.png b/docs/assets/esxi-disk.png new file mode 100644 index 0000000..122c35c Binary files /dev/null and b/docs/assets/esxi-disk.png differ diff --git a/docs/assets/f-icon.svg b/docs/assets/f-icon.svg new file mode 100644 index 0000000..1f474af --- /dev/null +++ b/docs/assets/f-icon.svg @@ -0,0 +1,4 @@ + + + + \ No newline at end of file diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 0000000..16e3231 Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..9f77209 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,56 @@ +# K3s Production {version} + +Welcome to the **K3s Production**. This virtual machine hosts workforce development apps from the [Software Engineering Institute](https://sei.cmu.edu) at [Carnegie Mellon University](https://cmu.edu). + +## Getting started + +To get started using the cluster: + +1. Download [root-ca.crt](root-ca.crt) and trust it in your keychain/certificate store. This removes browser certificate warnings. +2. Navigate to any of the apps in the following two sections. +3. Unless otherwise noted, the default credentials are: + + | key | value | + | -------- | ----------------------- | + | username | `administrator@foundry.texnet1.net` | + | password | `T3xn3t1admin!2!` | + | code | `123456` | + +## Common apps + +The following Foundry applications are loaded on this cluster: + +| location | api | description | +| ---------------------- | -------------------- | ---------------------------------------------------------------------------------------------------------------- | +| [/identity](/identity) | [api](/identity/api) | _Identity_ manages logins/credentials across all of the apps. It can integrate with any OAuth2/OIDC application. | + +## Third-party apps + +The following third-party applications are loaded on this cluster: + +| location | description | +| ------------------------ | --------------------------------------------------------------------------------------------------------------------- | +| [/dashboard](/dashboard) | _Kubernetes Dashboard_ provides details regarding the container deployment for the cluster. | +| [/gitea](/gitea) | _Gitea_ provides a user interface for editing the web content on the cluster (including this page). | +| [/pgadmin](/pgadmin) | _pgAdmin_ provides a GUI for managing the PostgreSQL databases for each app. | +| [/vscode](/vscode) | _code-server_ runs a browser version of [Visual Studio Code](https://code.visualstudio.com) to configure the cluster. | + +## Under the hood + +For command line access to the cluster: + +``` +ssh user@foundry.texnet1.net +``` + +The SSH password is `tartans@1`. Then you can run normal Kubernetes commands via `kubectl`. + +``` +kubectl get pods +``` + +The code for building this virtual machine is [available on GitHub](https://github.com/sei-noconnor/k3s-production) + +The cluster runs all of the apps in a Kubernetes cluster provided by [K3s](https://k3s.io/). This provides production-ready deployments in a datacenter or cloud. + +![CMU SEI Unitmark](assets/cmu-sei-unitmark.png){: style="width:400px;margin:40px 0px 0px"} diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..4409524 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,38 @@ +site_name: Foundry Appliance +site_url: https://foundry.local/start +markdown_extensions: + - attr_list + - md_in_html +theme: + name: material + palette: + - media: "(prefers-color-scheme: light)" + scheme: default + primary: blue + accent: pink + toggle: + icon: material/lightbulb-outline + name: Switch to dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + primary: light green + accent: amber + toggle: + icon: material/lightbulb + name: Switch to light mode + logo: assets/f-icon.svg + favicon: assets/favicon.png +repo_url: https://github.com/cmu-sei/foundry-appliance +repo_name: cmu-sei/foundry-appliance +edit_uri: "" +copyright: Copyright © 2022 Carnegie Mellon University +extra: + social: + - icon: fontawesome/brands/github + link: https://github.com/cmu-sei + - icon: fontawesome/brands/docker + link: https://hub.docker.com/u/cmusei + - icon: fontawesome/brands/twitter + link: https://twitter.com/sei_cmu + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/software-engineering-institute/