Skip to content

Commit

Permalink
Merge pull request #4216 from systeminit/keeb/update-getting-started-…
Browse files Browse the repository at this point in the history
…video

Update getting started tutorial video
  • Loading branch information
keeb authored Jul 24, 2024
2 parents 625e3e0 + 4020126 commit 57e15c3
Showing 1 changed file with 65 additions and 29 deletions.
94 changes: 65 additions & 29 deletions app/docs/src/tutorials/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,48 +1,64 @@
# Getting Started

<div style="position: relative; padding-bottom: calc(59.44589439871512% + 41px); height: 0; width: 100%;"><iframe src="https://demo.arcade.software/ANY7bzGXVx5cTLcqJbL4?embed&show_copy_link=true" title="Getting Started 2024-07-22" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen allow="clipboard-write" style="position: absolute; top: 0; left: 0; width: 100%; height: 100%;color-scheme: light;"></iframe></div>
<iframe width="560" height="315" src="https://www.youtube.com/embed/7vrIJmP49IE?si=GlRne9jG_l6FXSGX" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>

Welcome to System Initiative! This tutorial will teach you how to use System Initiative to model your infrastructure. We will be deploying a single free-tier EC2 instance in AWS, and cleaning it up. There should be no cost to you.
Welcome to System Initiative! This tutorial will teach you how to use System
Initiative to model your infrastructure. We will be deploying a single free-tier
EC2 instance in AWS, and cleaning it up. There should be no cost to you.

To follow along, you'll need three things:

1. [Sign up for System Initiative](https://auth.systeminit.com/signup).

2. An [AWS account that allows you to create free-tier resources](https://aws.amazon.com/free/), such as EC2 instances.
2. An
[AWS account that allows you to create free-tier resources](https://aws.amazon.com/free/),
such as EC2 instances.

3. Your System Initiative workspace open in another window.

## Creating a change set

Click the create [change set](../reference/vocabulary#change-set) button.

Name your new change set `Getting started`, and click the `Create change set` button.
Name your new change set `Getting started`, and click the `Create change set`
button.

## Add an AWS Credential component

Click `AWS Credential` from the AWS category of the asset pallete, and drop it on the diagram canvas. This creates a new [credential](../reference/vocabulary#credential) [component](../reference/vocabulary#component).
Click `AWS Credential` from the AWS category of the asset pallete, and drop it
on the diagram canvas. This creates a new
[credential](../reference/vocabulary#credential)
[component](../reference/vocabulary#component).

`Resize` the component until it fills most of the visible canvas by dragging the lower right corner of the frame.
`Resize` the component until it fills most of the visible canvas by dragging the
lower right corner of the frame.

## Name your component

Click on the `AWS Credential` you just added to the canvas. The panel on the right side of your screen will show the properties of It will have a default name like 'si-1234'.
Click on the `AWS Credential` you just added to the canvas. The panel on the
right side of your screen will show the properties of It will have a default
name like 'si-1234'.

Change the name to be `Tutorial`. Pressing enter or clicking outside the textbox will update the diagram with your new name.
Change the name to be `Tutorial`. Pressing enter or clicking outside the textbox
will update the diagram with your new name.

## Add a secret

Click the `Select/Add Secret` button next to the AWS Credential property. Then click `Add Secret`.
Click the `Select/Add Secret` button next to the AWS Credential property. Then
click `Add Secret`.

Name your secret `Tutorial Secret`.

Fill in your AWS accounts `Access Key Id` and `Secret Access Key`. [Refer to the AWS documentation if you do not know what they are](https://aws.amazon.com/blogs/security/how-to-find-update-access-keys-password-mfa-aws-management-console/).
Fill in your AWS accounts `Access Key Id` and `Secret Access Key`.
[Refer to the AWS documentation if you do not know what they are](https://aws.amazon.com/blogs/security/how-to-find-update-access-keys-password-mfa-aws-management-console/).

Click `Store Secret` to securely encrypt and save your [secret](../reference/vocabulary#secret).
Click `Store Secret` to securely encrypt and save your
[secret](../reference/vocabulary#secret).

## Add an AWS Region component and set its properties

Click on the `Region` from the AWS category of the asset pallete, and drop it inside your `tutorial credential` frame.
Click on the `Region` from the AWS category of the asset pallete, and drop it
inside your `tutorial credential` frame.

Resize the region to fill the space inside the `tutorial credential` frame.

Expand All @@ -52,7 +68,8 @@ Set the region property to `us-east-2`.

## Add an AWS EC2 Key Pair and set its properties

Click on the `Key Pair` from the AWS EC2 category of the asset pallete, and drop it inside your `ohio region` frame.
Click on the `Key Pair` from the AWS EC2 category of the asset pallete, and drop
it inside your `ohio region` frame.

Name your key pair `si-tutorial`.

Expand All @@ -75,35 +92,47 @@ the line between them.

## Add an AWS EC2 AMI component and set its properties

Click on the `AMI` from the AWS EC2 category of the asset pallete, and drop it inside your `Ohio region` frame.
Click on the `AMI` from the AWS EC2 category of the asset pallete, and drop it
inside your `Ohio region` frame.

Name your AMI `Fedora CoreOS`.

Set the ImageId property to `ami-04000bc04ccee958e`.

## Connect the AMI to the EC2 Instance

Connect the `Image ID` output socket of your AMI component to the `Image Id` input socket of your EC2 Instance component.
Connect the `Image ID` output socket of your AMI component to the `Image Id`
input socket of your EC2 Instance component.

## Apply the change set

Press the Escape key, or click on the background of the canvas, to ensure the workspace itself is selected.
Press the Escape key, or click on the background of the canvas, to ensure the
workspace itself is selected.

You will see two actions enqueued in the right hand panel - one to create the Key Pair, and the other to create your EC2 Instance.
You will see two actions enqueued in the right hand panel - one to create the
Key Pair, and the other to create your EC2 Instance.

Press the `Apply Change Set` button.

You'll be prompted with a dialog to confirm you want to take these two actions. Press the `Apply Changes` button in the dialog to confirm.
You'll be prompted with a dialog to confirm you want to take these two actions.
Press the `Apply Changes` button in the dialog to confirm.

## Create the Key Pair and EC2 Instance resources

Applying the change set redirects you to the `HEAD` change set, and enqueues your actions. The proposed changes panel on the right side of the screen shows your two pending actions. As the actions are run on AWS, their resulting [resources](../reference/vocabulary#resource) are added to each model. As this happens, the actions will disappear from the proposed changes list.
Applying the change set redirects you to the `HEAD` change set, and enqueues
your actions. The proposed changes panel on the right side of the screen shows
your two pending actions. As the actions are run on AWS, their resulting
[resources](../reference/vocabulary#resource) are added to each model. As this
happens, the actions will disappear from the proposed changes list.

Once both actions have been run, you'll see some confetti, and the changes panel will be empty.
Once both actions have been run, you'll see some confetti, and the changes panel
will be empty.

## Review the si-tutorial EC2 Instances resource data

Select the `si-tutorial EC2 Instance`. Then select the `Resource` sub-panel on the right side panel. You will see all the information about the EC2 Instance we created in AWS.
Select the `si-tutorial EC2 Instance`. Then select the `Resource` sub-panel on
the right side panel. You will see all the information about the EC2 Instance we
created in AWS.

Congratulations! You have created your first resources with System Initiative.

Expand All @@ -113,17 +142,21 @@ Create a new change set called `Cleanup`.

Select the `Tutorial AWS Credential` component. Press the delete key.

You'll be presented with a dialog confirming you want to delete the components we created previously. Click Confirm.
You'll be presented with a dialog confirming you want to delete the components
we created previously. Click Confirm.

Press the escape key or click on the canvas background to select the workspace.

Click the Apply Change Set button to delete your EC2 Instance and Key Pair. Confirm you want to apply the change set.
Click the Apply Change Set button to delete your EC2 Instance and Key Pair.
Confirm you want to apply the change set.

After the two delete actions are run, you will have a blank workspace, and no more resources running in AWS.
After the two delete actions are run, you will have a blank workspace, and no
more resources running in AWS.

## Congratulations!
## Congratulations

Congratulations - you've created your first resources with System Initiative. You learned how to:
Congratulations - you've created your first resources with System Initiative.
You learned how to:

- Create new change sets
- Add a credentials and secrets
Expand All @@ -136,6 +169,9 @@ Congratulations - you've created your first resources with System Initiative. Yo

You can:

- Follow the [Create Assets](./creating-new-assets.md) tutorial to learn about how to program and extend System Initiative
- Use your knowledge of AWS and System Initiative to learn how to create [AWS VPCs]
- Join us on [Discord](https://discord.com/invite/system-init) to ask any questions you may have
- Follow the [Create Assets](./creating-new-assets.md) tutorial to learn about
how to program and extend System Initiative
- Use your knowledge of AWS and System Initiative to learn how to create [AWS
VPCs]
- Join us on [Discord](https://discord.com/invite/system-init) to ask any
questions you may have

0 comments on commit 57e15c3

Please sign in to comment.