Skip to content
This repository has been archived by the owner on Sep 14, 2023. It is now read-only.

Commit

Permalink
more docs added
Browse files Browse the repository at this point in the history
  • Loading branch information
lbrick committed Sep 8, 2023
1 parent a3c059b commit 6b8f336
Show file tree
Hide file tree
Showing 23 changed files with 231 additions and 27 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/flexi/networks-overview-selected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/flexi/new-security-group-rules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/flexi/security-group-add-rule.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/flexi/security-groups-overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
hidden: false
label_names:
- networks
- create
- manage
- dashboard
position: 1
title: Create and manage network ports with the dashboard
---

## Create a Network

Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)

Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):

<figure markdown>
![Alt text](../../images/flexi/project-selector.png)
</figure>

Open the `Project` tab, open the `Network` tab, select the `Networks` category and then select the network you want to assign the network port to.

Click on the `Ports` tab

Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,20 @@ Select the project you would like to deploy the new instance too (Use the projec
![Alt text](../../images/flexi/project-selector.png)
</figure>

Open the `Project` tab, open the `Network` tab and select the `Networks` category
Open the `Project` tab, open the `Network` tab and select the `Networks` category

Select the network you wish to delete with the check box

<figure markdown>
![Alt text](../../images/flexi/networks-overview-selected.png)
</figure>

The `Delete Network` button should become a solid red

Click `Delete Network`

Within the `Confirm Delete Network` dialog ensure you have selected the correct network that is displayed.

Click `Delete Networks`

The network should now be deleted
34 changes: 30 additions & 4 deletions docs/user-guides/create-and-manage-networks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,40 @@ The networks within FlexiHPC are all `Software Defined Networks` so can overlap

Networks can be created and managed in 2 ways

- Create and Manage networks via the dashboard
- [Create and Manage networks with the Dashboard](create-and-manage-networks-with-the-dashboard.md)

- Create and Manage networks via CLI

Within the network tab you also have the following that you are able to manage

- Security Groups
## Security Groups

- Floating IPs
A security group acts as a virtual firewall for servers and other resources on a network. It is a container for security group rules which specify the network access rules.

- Static IPs
Security Groups can be created and managed within the FlexiHPC dashboard. However, advanced users can take advantage of the OpenStack CLI to manage Security Groups.

- [Create and Manage Security groups with the Dashboard](manage-security-groups-with-the-dashboard.md)

- Manage Security groups via CLI

## Floating IPs

When an instance is created in FlexiHPC, it is automatically assigned a fixed IP address in the network to which the instance is assigned. This IP address is permanently associated with the instance until the instance is terminated.

However, in addition to the fixed IP address, a floating IP address can also be attached to an instance. Unlike fixed IP addresses, floating IP addresses can have their associations modified at any time, regardless of the state of the instances involved. This procedure details the reservation of a floating IP address from an existing pool of addresses and the association of that address with a specific instance.

If you wish to connect to an instance within the FlexiHPC platform from outside then these are required.

- [Manage Floating IPs with the Dashboard](manage-floating-ips-via-the-dashboard.md)

- [Manage Floating IPs with the CLI](manage-floating-ips-via-cli.md)

## Static IPs

If you wanted to create an instance with a fixed static IP address this can be achieved by using network ports. A port is a connection point for attaching a single device, such as the NIC of a server, to an OpenStack network. A network port also describes the associated network configuration, such as the MAC and IP addresses to be used on that port.

These network ports can be managed 2 ways

- [Create and Manage network ports with the Dashboard](create-and-manage-network-ports-with-the-dashboard.md)

- Create and manage network ports via CLI
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,6 @@ vote_sum: 1
!!! note
The openstack CLI will need to be setup to interact with the FlexiHPC system. Please read [Setting up your CLI environment](../setting-up-your-CLI-environment/index.md) to interact with FlexiHPC to get started.

When an instance is created in FlexiHPC, it is automatically assigned a fixed IP address in the network to which the instance is assigned. This IP address is permanently associated with the instance until the instance is terminated.

However, in addition to the fixed IP address, a floating IP address can also be attached to an instance. Unlike fixed IP addresses, floating IP addresses can have their associations modified at any time, regardless of the state of the instances involved. This procedure details the reservation of a floating IP address from an existing pool of addresses and the association of that address with a specific instance.

If you wish to connect to an instance within the FlexiHPC platform from outside then these are required.

Use the `openstack` commands to manage floating IP addresses.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,12 +9,6 @@ vote_count: 1
vote_sum: 1
---

When an instance is created in FlexiHPC, it is automatically assigned a fixed IP address in the network to which the instance is assigned. This IP address is permanently associated with the instance until the instance is terminated.

However, in addition to the fixed IP address, a floating IP address can also be attached to an instance. Unlike fixed IP addresses, floating IP addresses can have their associations modified at any time, regardless of the state of the instances involved. This procedure details the reservation of a floating IP address from an existing pool of addresses and the association of that address with a specific instance.

If you wish to connect to an instance within the FlexiHPC platform from outside then these are required.

## Assign Floating IP address

Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
---
hidden: false
label_names:
- security-groups
- create
- manage
- dashboard
position: 1
title: Create and manage Security groups with the dashboard
---

## The Default secuirty group

Log into the [NeSI FlexiHPC Dashboard](https://dashboard.cloud.nesi.org.nz/)

Select the project you would like to deploy the new instance too (Use the project selector on the top left-hand side):

<figure markdown>
![Alt text](../../images/flexi/project-selector.png)
</figure>

Open the `Project` tab, open the `Network` tab and select the `Security Groups` category

!!! note
We recommend that no new rules are added to the `deafult` security group to keep things clean and tidy. We also recommend that no rules be removed from this group.

<figure markdown>
![Alt text](../../images/flexi/default-security-group-rules.png)
</figure>

There are 2 Egress and 2 Ingress rules, each one is associated with either IPv4 or IPv6.

The 2 Egress rules allow the resources within the FlexiHPC project to communicate with the outside world.

The 2 Ingress rules allow any other resource within the FlexiHPC project that has this security group associated to it is allowed to communicate with each other.

## Creating a new Security Group

First start by clicking on `Create Security Group`

<figure markdown>
![Alt text](../../images/flexi/security-groups-overview.png)
</figure>

Within the `Create Security Group` dialog you have the following options.

`Name`
: A friendly name for your network, this field is requried.

`Description`
: A friendly description to identify what this is used for

Once those have been filled out hit the `Create Security Group` button and that will take you to the newly created security group

<figure markdown>
![Alt text](../../images/flexi/new-security-group-rules.png)
</figure>

## Updating a Security Groups Rules

We have a few ways of adding new rules to the security groups, either with predefined rules or customs rules.

### Using Predefined Rules

Find the security group that you would like to update the rules for and click `Manage Rules` under the `Action` column

<figure markdown>
![Alt text](../../images/flexi/security-group-manage-rules.png)
</figure>

Once in the security group we want to click on `Add Rule` on the top right

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule.png)
</figure>

We are presented with the following dialog that allows us to add new rules based on the direction(Ingress/Egress) that we want to apply the rule. Think of these as Firewall Rules

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule-dialog.png)
</figure>

There are all ready a few predefined rules that are ready to use if you so chose

<figure markdown>
![Alt text](../../images/flexi/security-group-predefined-rules.png)
</figure>

For this example we will create an `SSH` rule

<figure markdown>
![Alt text](../../images/flexi/security-group-predefined-rule-example.png)
</figure>

We have specified the `SSH` Rule, given it a description so it explains what it is for other users, we have chosen `CIDR` as the remote and left the `CIDR` as `Allow All`.

!!! info
If we changed that CIDR to 192.168.0.0/16 then only machines that reside within that IP Range will be able to pass through this Rule.

For the above example we want to be able to SSH to a Compute Service within the FlexiHPC space however the IP that we would be connecting from would be our Public IP, therefore using the above CIDR would actually block our attempts to SSH to the compute service that has this rule applied.

If you wish to restrict the Rule to only your Public IP then google whats my ip and use the IP that is provided prefixed with /32

Clicking `Add` will update the Security group with the newly created rule

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule-new.png)
</figure>

### Using Custom Rules

Find the security group that you would like to update the rules for and click `Manage Rules` under the `Action` column

<figure markdown>
![Alt text](../../images/flexi/security-group-manage-rules.png)
</figure>

Once in the security group we want to click on `Add Rule` on the top right

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule.png)
</figure>

We are presented with the following dialog that allows us to add new rules based on the direction(Ingress/Egress) that we want to apply the rule. Think of these as Firewall Rules

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule-dialog.png)
</figure>

For this Example rule we will allow port `6443`.

So the things we need to ensure are Rule has been set to `Custom TCP Rule`, The Direction is `Ingress` as we are allowing the port into the FlexiHPC space and the Port we would like to allow, in this case `6443`.

We will also leave Remote as `CIDR` and the `CIDR` as allow all, as denoted by `0.0.0.0/0`

<figure markdown>
![Alt text](../../images/flexi/security-group-add-rule-custom-example.png)
</figure>

We click `Add` and our rule is now added to the security group

<figure markdown>
![Alt text](../../images/flexi/security-group-add-custom-rule-new.png)
</figure>
11 changes: 8 additions & 3 deletions docs/user-guides/create-and-manage-networks/summary.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
* [Create and Manage Volumes](index.md)
* [Networks: Create and Manage](index.md)
* With the Dashboard
* [Create and Manage](create-and-manage-networks-with-the-dashboard.md)
* [Create and Manage Networks](create-and-manage-networks-with-the-dashboard.md)
* [Create and Manage Security Groups](manage-security-groups-with-the-dashboard.md)
* [Create and Manage Network Ports](create-and-manage-network-ports-with-the-dashboard.md)
* [Manage Floating IPs](manage-floating-ips-via-the-dashboard.md)
* With the CLI
* [Create and Manage](create-and-manage-volumes-via-cli.md)
* [Create and Manage](create-and-manage-volumes-via-cli.md)
* [Manage Floating IPs](manage-floating-ips-via-cli.md)
* *
2 changes: 1 addition & 1 deletion docs/user-guides/create-and-manage-volumes/summary.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* [Create and Manage Volumes](index.md)
* [Volumes: Create and Manage](index.md)
* With the Dashboard
* [Create and Manage](create-and-manage-volumes-with-the-dashboard.md)
* With the CLI
Expand Down
4 changes: 1 addition & 3 deletions docs/user-guides/launch-and-mange-instances/summary.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,11 @@
* [Launch and Manage Instances](index.md)
* [Compute: Create and Manage](index.md)
* With the Dashboard
* [Launch an Instance](launch-an-instance-via-dashboard.md)
* [Resizing an Instance](resizing-an-Instance-via-the-dashboard.md)
* [Manage Floating IPs](manage-floating-ips-via-the-dashboard.md)
* With the CLI
* [Gather details to launch an Instance](launch-an-instance-via-cli.md)
* [Launch an Instance from an Image](launch-an-instance-from-an-image.md)
* [Launch an Instance from a Volume](launch-an-instance-from-a-volume.md)
* [Risizing an Instance](resizing-an-Instance-via-cli.md)
* [Manage Floating IPs](manage-floating-ips-via-cli.md)
* Other Tools
* [Deploy with Terraform](deployment-of-an-instance-with-terraform.md)
7 changes: 4 additions & 3 deletions docs/user-guides/summary.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
* [User Guides](index.md)
* [Launch and Manage Instances](launch-and-mange-instances/)
* [Upload and Manage Images](uploading-and-managing-Images/)
* [Create and Manage Volumes](create-and-manage-volumes/)
* [Compute: Create and Manage](launch-and-mange-instances/)
* [Images: Upload and Manage](uploading-and-managing-Images/)
* [Volumes: Create and Manage](create-and-manage-volumes/)
* [Networks: Create and Manage](create-and-manage-networks/)
* [Set up your CLI environment](setting-up-your-CLI-environment/)
* */
2 changes: 1 addition & 1 deletion docs/user-guides/uploading-and-managing-Images/summary.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
* [Upload and Manage Images](index.md)
* [Images: Upload and Manage](index.md)
* With the Dashboard
* [Upload Image](upload-an-image-via-the-dashboard.md)
* [Managing Images](managing-images-via-the-dashboard.md)
Expand Down

0 comments on commit 6b8f336

Please sign in to comment.