Browse Source

Update 'docs/index.md'

master
administrator 2 years ago
parent
commit
af46eb30d3
  1. 65
      docs/index.md

65
docs/index.md

@ -1,56 +1,31 @@
# K3s Production {version}
# Application Directory
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:
## Foundry and Crucible
| 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. |
| [/topomojo](/topomojo) | [api](/topomojo/api) | _TopoMojo_ allows users to build on-demand labs. |
| [/alloy](/alloy) | [api](/alloy/api) | _Alloy_ joins the other independent Crucible apps together to provide a complete Crucible experience (i.e. labs, on-demand exercises, exercises, etc.). |
| [/player](/player) | [api](/player/api) | _Player_ is the centralized interface where users, teams, and administrators go to participate in the cyber exercise. |
| [/caster](/caster) | [api](/caster/api) | _Caster_ provides a web interface that gives exercise developers a way to create, share, and manage topology configurations. |
| [/steamfitter](/steamfitter) | [api](/steamfitter/api) | _Steamfitter_ creates scenarios consisting of a series of scheduled tasks, manual tasks, and injects which run against virtual machines in an exercise/delivery. |
| [/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:
## Learning Management System
| 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
```
| -------------------------------- | ------------------------------------------------------------------------------------------------ |
| [moodle](https://moodle.foundry.texnet1.net | _Moodle_ is an LMS that provides the framework that handles all aspects of the learning process. |
The SSH password is `tartans@1`. Then you can run normal Kubernetes commands via `kubectl`.
# Third-party Applications
```
kubectl get pods
```
The code for building this virtual machine is [available on GitHub](https://github.com/sei-noconnor/k3s-production)
The following third-party applications are loaded on this cluster:
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.
| location | description |
| -------------------------- | ------------------------------------------------------------- |
| [/gitea](/gitea) | _Gitea_ provides a user interface for editing the web content |
| [/gitlab](/gitlab) | _Gitlab_ Module repo for caster |
| [/stackstorm](/stackstorm) | _StackStorm_ Task processing for steamfitter |
![CMU SEI Unitmark](assets/cmu-sei-unitmark.png){: style="width:400px;margin:40px 0px 0px"}
![CMU SEI Unitmark](assets/cmu-sei-unitmark.png)
Loading…
Cancel
Save