Skip to content

Commit

Permalink
Merge pull request #27 from lbrick/KAHU-Update_Compute_pages_from_fee…
Browse files Browse the repository at this point in the history
…dback

fix links, re-order for better readablity
  • Loading branch information
lbrick authored Nov 2, 2023
2 parents 07bb6df + 00341b2 commit 7c91053
Show file tree
Hide file tree
Showing 14 changed files with 134 additions and 20 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/assets/images/flexi/new-key-pair-filled.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/assets/images/flexi/new-key-pair.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,86 @@
---
hidden: false
label_names:
- keypairs
- create
- manage
- dashboard
position: 1
title: Create and manage keypairs via the dashboard
---

## Create a Keypair

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](../../assets/images/flexi/project-selector.png)
</figure>

Open the `Project` tab, open the `Compute` tab and select the `Key Pairs` category

Click `Create Key Pair`.

<figure markdown>
![Alt text](../../assets/images/flexi/new-key-pair.png)
</figure>

In the `Create Key Pair` dialog box, enter a name for your `key pair,` and select a `Key Type`

`Key Type`
: Select one of the following options

- `SSH Key`
: This will be the common picked `Key Type` as we will use this to SSH to most compute instances.

- `X509 Certificate`
: This will be used to generate an Certificate based key.

<figure markdown>
![Alt text](../../assets/images/flexi/new-key-pair-filled.png)
</figure>

Once all fields are supplied click `Create Key Pair`

The private key will be downloaded automatically

<figure markdown>
![Alt text](../../assets/images/flexi/new-key-pair-download.png)
</figure>

To change its permissions so that only you can read and write to the file, run the following command:

```
chmod 0600 yourPrivateKey.pem
```

!!! note
If you are using the Dashboard from a Windows computer, use PuTTYgen to load the `*.pem` file and convert and save it as `*.ppk`. For more information see the [WinSCP web page for PuTTYgen](https://winscp.net/eng/docs/ui_puttygen).

To make the key pair known to SSH, run the ssh-add command.

```
ssh-add yourPrivateKey.pem
```

## Import a Key Pair

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](../../assets/images/flexi/project-selector.png)
</figure>

Open the `Project` tab, open the `Compute` tab and select the `Key Pairs` category

Click `Import Key Pair`.

In the `Import Key Pair` dialog box, enter the name of your key pair, copy the public key into the `Public Key` box, and then click `Import Key Pair`.

The Compute database registers the public key of the key pair.

The Dashboard lists the key pair on the `Key Pairs` tab.
20 changes: 20 additions & 0 deletions docs/user-guides/create-and-manage-keypairs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
hidden: false
label_names:
- identity
- create
- manage
position: 1
title: Create and Manage Keypairs
vote_count: 1
vote_sum: 1
---

Key pairs are SSH credentials that are injected into a FlexiHPC instance when it is launched. These are used to access and manage your instances.

You are able to create a new SSH Key pair on the RDC or import one of your own.


Key pairs can be managed a few ways

- [Create and manage key pairs via the dashboard](create-and-manage-keypairs-with-the-dashboard.md)
4 changes: 4 additions & 0 deletions docs/user-guides/create-and-manage-keypairs/summary.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
* [Keypairs: Create and Manage](index.md)
* With the Dashboard
* [Create and Manage](create-and-manage-keypairs-with-the-dashboard.md)
* *
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Connect to your instance by using SSH

To use SSH to connect to your instance, use the downloaded keypair file.

!!! note
The user name is `ubuntu` for the Ubuntu cloud images on FlexiHPC.

Insure your instance has a `floating ip` associated with it. If you need to assign one then check the following Assign Floating IP to an Instance via the Dashboard

Copy the `floating ip` address for your instance.

Use the **ssh** command to make a secure connection to the instance. For example:
```
ssh -i MyKey.pem [email protected]
```
At the prompt, type `yes`.
16 changes: 0 additions & 16 deletions docs/user-guides/launch-and-mange-instances/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,22 +23,6 @@ This is a more advance way of interacting with the FlexiHPC platform. It require

After reading one of the above you should be able to connect to the instance using ssh.

## Connect to your instance by using SSH
To use SSH to connect to your instance, use the downloaded keypair file.

!!! note
The user name is `ubuntu` for the Ubuntu cloud images on FlexiHPC.

Insure your instance has a `floating ip` associated with it. If you need to assign one then check the following Assign Floating IP to an Instance via the Dashboard

Copy the `floating ip` address for your instance.

Use the **ssh** command to make a secure connection to the instance. For example:
```
ssh -i MyKey.pem [email protected]
```
At the prompt, type `yes`.

## Resizing an Instance

Resizing an instance allows you to scale the instance either up, if your workload requires a bit more grunt, or down, should you no longer need to consume a large amount of resources.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -270,4 +270,4 @@ openstack server create --flavor 3b5a6e01-d3ad-49e3-a4f8-183c04444330 --volume 3

Ubuntu and CentOS cloud images also don't allow password SSH by default.

To allow external access a floating IP will need to be provided to the newly created instance, following [Manage Floating IPs via CLI](../create-and-manage-networks/manage-floating-ips-via-cli.md) will complete this for you.
To allow external access a floating IP will need to be provided to the newly created instance, following [Manage Floating IPs via CLI](../create-and-manage-networks/manage-floating-ips-via-cli.md) will complete this for you, You should then be able to connect to your instance using ssh which is explained more in [Connect to your instance by using SSH](connect-to-instance-ssh.md).
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ The list shows the ID, name, status, and private (and if assigned, public) IP ad

If the status for the instance is `ACTIVE`, the instance is online.

If you would like to access your Compute instance outside the FlexiHPC platform you will need to associate a `floating ip` to your instance. Reading [Manage Floating IPs via CLI](../create-and-manage-networks/manage-floating-ips-via-cli.md), You should then be able to connect to your instance using ssh which is explained more in Connect to your instance by using SSH.
If you would like to access your Compute instance outside the FlexiHPC platform you will need to associate a `floating ip` to your instance. Reading [Manage Floating IPs via CLI](../create-and-manage-networks/manage-floating-ips-via-cli.md), You should then be able to connect to your instance using ssh which is explained more in [Connect to your instance by using SSH](connect-to-instance-ssh.md).
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Before you can launch an instance via the CLI, gather the following parameters:

- Access and security credentials, which include one or both of the following credentials:

- A `key pair` for your instance, which are SSH credentials that are injected into images when they are launched. Create at least one key pair for each project. If you already have generated a key pair with an external tool, you can import it into OpenStack. You can use the key pair for multiple instances that belong to that project. Reading Creating and Importing Key Pairs if you would like to know more.
- A `key pair` for your instance, which are SSH credentials that are injected into images when they are launched. Create at least one key pair for each project. If you already have generated a key pair with an external tool, you can import it into OpenStack. You can use the key pair for multiple instances that belong to that project. Read [Create and Manage Key Pairs](../create-and-manage-keypairs/index.md) if you would like to know more.

- A `security group` that defines which incoming network traffic is forwarded to instances. Security groups hold a set of firewall policies, known as security group rules.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -146,4 +146,6 @@ The instance starts on a compute node in the cloud.
!!! info
If you require an external connection to this instance then a floating IP is required. The article

[Manage Floating IPs via the Dashboard](../create-and-manage-networks/manage-floating-ips-via-the-dashboard.md) will detail the requirements to complete this.
[Manage Floating IPs via the Dashboard](../create-and-manage-networks/manage-floating-ips-via-the-dashboard.md) will detail the requirements to complete this.

You should now be able to connect to your instance using ssh which is explained more in [Connect to your instance by using SSH](connect-to-instance-ssh.md).
1 change: 1 addition & 0 deletions docs/user-guides/launch-and-mange-instances/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@
* [Risizing an Instance](resizing-an-Instance-via-cli.md)
* Other Tools
* [Deploy with Terraform](deployment-of-an-instance-with-terraform.md)
* [Connecting to your instance with SSH](connect-to-instance-ssh.md)
* [Default user for images](default-user-nesi-images.md)
1 change: 1 addition & 0 deletions docs/user-guides/summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,6 @@
* [Volumes: Create and Manage](create-and-manage-volumes/)
* [Networks: Create and Manage](create-and-manage-networks/)
* [Identity: Create and Manage](create-and-manage-identity/)
* [Keypairs: Create and Manage](create-and-manage-keypairs/)
* [Set up your CLI environment](setting-up-your-CLI-environment/)
* */

0 comments on commit 7c91053

Please sign in to comment.