Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/gh-pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,14 @@ jobs:
steps:
- uses: actions/checkout@v3

- name: Setup mdBook (with plugins)
uses: jontze/action-mdbook@v2
- name: Setup mdBook
uses: jontze/action-mdbook@v3
with:
token: ${{secrets.GITHUB_TOKEN}}
mdbook-version: '0.4.52'
use-admonish: true
mdbook-version: '0.5.2'


- run: mdbook build
- name: Build mdBook
run: mdbook build

- name: Fix navigation paths for production
run: ./inject-base-url.sh "" "./book"
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/preview.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,12 @@ jobs:
- name: Checkout
uses: actions/checkout@v3

- name: Setup mdBook (with plugins)
uses: jontze/action-mdbook@v2
- name: Setup mdBook
uses: jontze/action-mdbook@v3
if: github.event.action != 'closed'
with:
token: ${{secrets.GITHUB_TOKEN}}
mdbook-version: '0.4.52'
use-admonish: true
mdbook-version: '0.5.2'

- name: Build mdBook site
run: mdbook build
Expand Down
9 changes: 4 additions & 5 deletions book.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,15 @@ language = "en"
src = "src"
title = "Clouds and Platforms"

[preprocessor.admonish]
command = "mdbook-admonish"
assets_version = "3.0.2" # do not edit: managed by `mdbook-admonish install`

[output.html]
default-theme = "aggie"
preferred-dark-theme = "navy"
additional-css = ["./theme/css/mdbook-admonish.css", "./theme/css/tabbed-code-blocks.css", "./theme/css/aggie-custom.css"]
additional-css = ["./theme/css/tabbed-code-blocks.css", "./theme/css/aggie-custom.css"]
additional-js = ["./theme/js/tabbed-code-blocks.js"]
git-repository-url = "https://github.com/tamu-edu/it-cloud-docs"
edit-url-template = "https://github.com/tamu-edu/it-cloud-docs/edit/main/{path}"
# mdBook 0.5 options - disable new sidebar header navigation to maintain current look
sidebar-header-nav = false

[output.html.print]
enable = false
Expand Down
7 changes: 4 additions & 3 deletions src/cloud/aws.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@ To learn about and request an AWS account, please visit the [Public Cloud Accoun

The AWS Management Console is a web-based interface for accessing and managing AWS services. You can sign in to the console at [https://console.aws.amazon.com/](https://console.aws.amazon.com/) using your NetID.

```admonish info class="aggiecustom2" title="Access AWS"
[https://console.aws.amazon.com/](https://console.aws.amazon.com/)
```
> [!NOTE]
> **Access AWS**
>
> [https://console.aws.amazon.com/](https://console.aws.amazon.com/)

### Using the AWS CLI

Expand Down
23 changes: 10 additions & 13 deletions src/cloud/aws/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,23 +92,20 @@ To move within the same region:



```admonish info
Details for migrating RDS in the same region: [Migrate an Amazon RDS DB instance to another VPC](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/migrate-an-amazon-rds-db-instance-to-another-vpc-or-account.html).
```
> [!NOTE]
> Details for migrating RDS in the same region: [Migrate an Amazon RDS DB instance to another VPC](https://docs.aws.amazon.com/prescriptive-guidance/latest/patterns/migrate-an-amazon-rds-db-instance-to-another-vpc-or-account.html).

```admonish info
Details for migrating RDS to a different region: [Migrate Amazon Aurora and Amazon RDS to a new AWS region](https://aws.amazon.com/blogs/database/migrate-amazon-aurora-and-amazon-rds-to-a-new-aws-region/).
```
> [!NOTE]
> Details for migrating RDS to a different region: [Migrate Amazon Aurora and Amazon RDS to a new AWS region](https://aws.amazon.com/blogs/database/migrate-amazon-aurora-and-amazon-rds-to-a-new-aws-region/).

```admonish info
Details for moving an RDS instance out of an Availability Zone: [How do I move an Amazon RDS instance out of an Availability Zone?](https://repost.aws/knowledge-center/rds-move-availability-zone) Note that you will need to be sure that the AZ that the RDS is moved to is [one of the supported AZ's](https://docs.cloud.tamu.edu/cloud/aws/networking.html#using-subnets)
```
> [!NOTE]
> Details for moving an RDS instance out of an Availability Zone: [How do I move an Amazon RDS instance out of an Availability Zone?](https://repost.aws/knowledge-center/rds-move-availability-zone) Note that you will need to be sure that the AZ that the RDS is moved to is [one of the supported AZ's](https://docs.cloud.tamu.edu/cloud/aws/networking.html#using-subnets)

### Redshift Clusters

To move a Redshift cluster to a different subnet group, you can modify the cluster to use the new subnet group. If you need to move to a different VPC, you can create a snapshot of the cluster and restore it in the new VPC.

```admonish info
Details for migrating Redshift:
- [Migrate Amazon Redshift to a new subnet group](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-subnet-group-console.html)
- [Migrate Amazon Redshift to a new VPC](https://repost.aws/knowledge-center/move-redshift-cluster-vpcs)
> [!NOTE]
> Details for migrating Redshift:
> - [Migrate Amazon Redshift to a new subnet group](https://docs.aws.amazon.com/redshift/latest/mgmt/managing-cluster-subnet-group-console.html)
> - [Migrate Amazon Redshift to a new VPC](https://repost.aws/knowledge-center/move-redshift-cluster-vpcs)
32 changes: 16 additions & 16 deletions src/cloud/aws/networking.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,20 +80,20 @@ When you create resources in AWS, you will need to select a subnet to place the

- See below for sample Terraform code to specifically select the subset of subnets that are public. Note that valid choices for the `values = ["public"]` line are `public`, `private` and `campus` (if the campus subnet has been shared with your account).

```admonish info
data "aws_vpc" "default" {
default = false
id = "vpc-0c31fe331850b85b5"
}

data "aws_subnets" "default" {
filter {
name = "vpc-id"
values = [data.aws_vpc.default.id]
}
filter {
name = "tag:subnet-type"
values = ["public"]
}
}
```terraform
data "aws_vpc" "default" {
default = false
id = "vpc-0c31fe331850b85b5"
}

data "aws_subnets" "default" {
filter {
name = "vpc-id"
values = [data.aws_vpc.default.id]
}
filter {
name = "tag:subnet-type"
values = ["public"]
}
}
```
5 changes: 2 additions & 3 deletions src/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
```admonish info
This site is a work in progress and will be updated regularly. Please check back frequently for updates.
```
> [!NOTE]
> This site is a work in progress and will be updated regularly. Please check back frequently for updates.

This website is a resource for Texas A&M University faculty, and staff to learn about the various infrastructure and platform services available at Texas A&M University. This includes information about cloud services, platform services, and security policies and best practices.

Expand Down
5 changes: 2 additions & 3 deletions src/kion/features/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,5 @@ When you select a project, you will have several options at the top of the page
- **Notes** - This tab shows any notes that have been added to the project. This section is currently not able to be edited but will be in the future.
- **Settings** - This tab allows you to change notification settings for the project.

```admonish info
Detailed descriptions for each of these tabs are available in [Kion's Customer Success Center](https://support.kion.io/hc/en-us/articles/360057133931-Project-Details).
```
> [!NOTE]
> Detailed descriptions for each of these tabs are available in [Kion's Customer Success Center](https://support.kion.io/hc/en-us/articles/360057133931-Project-Details).
70 changes: 43 additions & 27 deletions src/kion/features/key_features.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,62 +4,78 @@

- Access your cloud accounts via the Overview tab:

```admonish collapsible=true class="aggiecustom2" title="Kion Overview"
<details>
<summary>Kion Overview</summary>

![Kion Overview](./img/cloud_access.png)
```
</details>

- Track budgets, monthly spending, and get estimated spend (based on current usage) for all accounts associated with a project in the Financials tab.

```admonish collapsible=true class="aggiecustom2" title="Kion Financials"
<details>
<summary>Kion Financials</summary>

![Kion Financials](./img/project_spending.png)
```
</details>


- In the Compliance tab, Track compliance posture against several industry standards, including CIS 1.2.0 for AWS and 1.3.0 for Azure, and against Texas A&M University's Security Controls catalog for the varying degrees of data classification.

- In the Compliance tab, Track compliance posture against several industry standards, including CIS 1.2.0 for AWS and 1.3.0 for Azure, and against Texas A&M University’s Security Controls catalog for the varying degrees of data classification.
<details>
<summary>Kion Compliance</summary>

```admonish collapsible=true class="aggiecustom2" title="Kion Compliance"
![Kion Compliance](./img/compliance_tab.png)
```
</details>

<details>
<summary>Compliance Findings</summary>

```admonish collapsible=true class="aggiecustom2" title="Compliance Findings"
![Compliance Standards](./img/compliance_checks.png)
```
</details>

<details>
<summary>Finding Details</summary>

```admonish collapsible=true class="aggiecustom2" title="Finding Details"
![Compliance findings](./img/compliance_details.png)
```
</details>


- Grant access to your projects or individual accounts after the user receiving access to the accounts has already logged into Kion.

```admonish collapsible=true class="aggiecustom2" title="Project Access"
<details>
<summary>Project Access</summary>

![Project Access](./img/project_user_groups.png)
```
</details>

- Identify savings opportunities by identifying over-provisioned resources that can be reduced in size and cost in the Savings Opportunities Tab.

```admonish note
screenshot pending, as the example project does not have any current savings opportunities.
```
> [!NOTE]
> screenshot pending, as the example project does not have any current savings opportunities.

## Advanced Features

- In the Enforcements tab, configure actions you can set to trigger on an project when a spending limit is surpassed. See Kion’s documentation on Project Financial Enforcements for more information.
- In the Enforcements tab, configure actions you can set to trigger on an project when a spending limit is surpassed. See Kion's documentation on Project Financial Enforcements for more information.

<details>
<summary>Budget Enforcements</summary>

```admonish collapsible=true class="aggiecustom2" title="Budget Enforcements"
![Budget Enforcements](./img/budget_enforcements.png)
```
</details>

<details>
<summary>Enforcement Example</summary>

```admonish collapsible=true class="aggiecustom2" title="Enforcement Example"
![Enforcement Example](./img/enforcement_example.png)
```
</details>

- In the Cloud Management tab, you can create customized permissions for users or service accounts and apply new compliance standards. See Kion's documentation on Cloud Access Roles and Cloud Rules for more information.

- In the Cloud Management tab, you can create customized permissions for users or service accounts and apply new compliance standards. See Kion’s documentation on Cloud Access Roles and Cloud Rules for more information.
<details>
<summary>Cloud Access</summary>

```admonish collapsible=true class="aggiecustom2" title="Cloud Access"
![Cloud Access](./img/example_car.png)
```
</details>

```admonish note
for more information on Cloud Access Roles and Cloud Rules, please refer to [User Group Management](./user_group_management.md)
```
> [!NOTE]
> for more information on Cloud Access Roles and Cloud Rules, please refer to [User Group Management](./user_group_management.md)
19 changes: 11 additions & 8 deletions src/kion/features/troubleshooting_and_support.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,23 @@

If you are experiencing issues with Kion, please refer to the robust support documentation available at [support.kion.io](https://support.kion.io/hc/en-us).

```admonish collapsible=true class="aggiecustom2" title="Kion Support Page"
<details>
<summary>Kion Support Page</summary>

![Kion Support Page](./img/support_page_example.png)
```
</details>

This documentation is also accessible from the Kion platform by clicking the "?" button in the top right corner of the page.

```admonish collapsible=true class="aggiecustom2" title="Kion Support Button"
<details>
<summary>Kion Support Button</summary>

![Kion Support Button](./img/troubleshooting.png)
```
</details>

<!-- If you are unable to find a solution to your issue, please contact the Kion support team by submitting a request in the upper right-hand corner of the support page. -->

```admonish note
Official contact information for TAMU Kion Administrators is still pending.
For now, please contact Andrew Dean or Joseph Rafferty via Teams or Slack for support.
```
> [!NOTE]
> Official contact information for TAMU Kion Administrators is still pending.
> For now, please contact Andrew Dean or Joseph Rafferty via Teams or Slack for support.

Loading