From 6772799ece587c8912dda134e219c322f6566141 Mon Sep 17 00:00:00 2001 From: cal Date: Wed, 25 Sep 2024 17:25:57 +1200 Subject: [PATCH] Fix a bunch of broken links --- ...-research-developer-cloud-updates-v0.11.md | 3 +- .../security-practices/building-eff-rsp.md | 12 +- .../create-and-manage-networks/index.md | 8 +- ...create-and-manage-network-ports-via-cli.md | 383 ++++++++++++++++++ .../create-and-manage-networks-via-cli.md | 257 ++++++++++++ .../manage-floating-ips-via-cli.md | 143 +++++++ .../manage-security-groups-via-cli.md | 183 +++++++++ ...manage-network-ports-with-the-dashboard.md | 28 +- ...-and-manage-networks-with-the-dashboard.md | 12 +- .../manage-floating-ips-via-the-dashboard.md | 8 +- ...nage-security-groups-with-the-dashboard.md | 30 +- .../create-and-manage-object-storage/index.md | 2 +- ...anage-object-storage-with-the-dashboard.md | 18 +- ...e-and-manage-volumes-with-the-dashboard.md | 14 +- docs/user-guides/index.md | 2 +- .../connect-to-instance-ssh.md | 2 +- .../launch-and-manage-instances/index.md | 4 +- .../launch-an-instance-from-a-volume.md | 2 +- .../launch-an-instance-from-an-image.md | 5 +- .../launch-an-instance-via-cli.md | 2 +- .../launch-an-instance-via-dashboard.md | 4 +- ...groups-of-an-Instance-via-the-dashboard.md | 14 +- .../resizing-an-Instance-via-the-dashboard.md | 8 +- .../with-the-cli/upload-an-image-via-cli.md | 6 +- .../managing-images-via-the-dashboard.md | 4 +- .../upload-an-image-via-the-dashboard.md | 4 +- 26 files changed, 1062 insertions(+), 96 deletions(-) create mode 100644 docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-network-ports-via-cli.md create mode 100644 docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-networks-via-cli.md create mode 100644 docs/user-guides/create-and-manage-networks/with_the_CLI/manage-floating-ips-via-cli.md create mode 100644 docs/user-guides/create-and-manage-networks/with_the_CLI/manage-security-groups-via-cli.md diff --git a/docs/release-notes/20240205-research-developer-cloud-updates-v0.11.md b/docs/release-notes/20240205-research-developer-cloud-updates-v0.11.md index b129fdf..750d1a3 100644 --- a/docs/release-notes/20240205-research-developer-cloud-updates-v0.11.md +++ b/docs/release-notes/20240205-research-developer-cloud-updates-v0.11.md @@ -12,7 +12,8 @@ title: Research Developer Cloud updates v0.11 - 20240205 * UPDATE: [Rocky1](https://rockylinux.org/) images are now available for tenants to use on VMs ####Object Storage -* UPDATE: Now operational and is in a user-testing phase. Please reach out if you would like some quota and help getting started! Early documentation can be found here: [Create and Manage Object Storage - Research Developer Cloud](/user-guides/create-and-manage-object-storage/) +* UPDATE: Now operational and is in a user-testing phase. Please reach out if you would like some quota and help getting started! Early documentation can be found here: +[Create and Manage Object Storage - Research Developer Cloud](../user-guides/create-and-manage-object-storage/index.md) ##Blueprints diff --git a/docs/security/security-practices/building-eff-rsp.md b/docs/security/security-practices/building-eff-rsp.md index 118e823..3762f0f 100644 --- a/docs/security/security-practices/building-eff-rsp.md +++ b/docs/security/security-practices/building-eff-rsp.md @@ -1,9 +1,7 @@ --- -hidden: false label_names: - security - practices -position: 1 title: Building Effective and Efficient Research Security Programs --- @@ -22,7 +20,7 @@ Why - Is there an external driver or internal improvement? How - The plan: getting executive support, marketing, training, consulting, measurement, reporting, closure.
- ![Alt text](../../../assets/images/security/5w-and-1h.png) + ![Alt text](../../assets/images/security/5w-and-1h.png)
`Think Like a Researcher` @@ -31,13 +29,13 @@ We must find the balance between compulsory and optional. Researchers don't like Understand the challenges they face on a day to day basis. Take the questions they ask as they begin and execute a project then create the map to the answers. It is very likely they are spread across teams, services, platforms, or even specific individuals. That is a massive barrier to a someone solving their own problems, which researchers are very good at! They aren't good at intuiting the solution you think they should choose unless they know it's an option.
- ![Alt text](../../../assets/images/security/topic-maze.png) + ![Alt text](../../assets/images/security/topic-maze.png)
Align services as answers to questions in single platform, service, or space. Map activities to the research lifecycle and how each one can be accessed, leveraged, or simply requested to help them achieve and maintain compliance
- ![Alt text](../../../assets/images/security/topic-maze-solved.png) + ![Alt text](../../assets/images/security/topic-maze-solved.png)
`Telling the Story` @@ -45,7 +43,7 @@ Align services as answers to questions in single platform, service, or space. Ma You need executive buy in and support prior to rolling these programs out to researchers. Researchers will ask their deans, department heads, and DVCRs directly `Why?`, and they need to be able to answer it concisely and completely. Provide metrics, statistics, and easy to share material to make those discussions easier. Here are some examples
- ![Alt text](../../../assets/images/security/ee-supporting-evidence.png) + ![Alt text](../../assets/images/security/ee-supporting-evidence.png)
`Resources` @@ -56,4 +54,4 @@ You need executive buy in and support prior to rolling these programs out to res [Data Breach Numbers](https://www.govtech.com/blogs/lohrmann-on-cybersecurity/data-breach-numbers-costs-and-impacts-all-rise-in-2021) -## \ No newline at end of file +## diff --git a/docs/user-guides/create-and-manage-networks/index.md b/docs/user-guides/create-and-manage-networks/index.md index 5a8c9ca..1506398 100644 --- a/docs/user-guides/create-and-manage-networks/index.md +++ b/docs/user-guides/create-and-manage-networks/index.md @@ -18,7 +18,7 @@ Networks can be created and managed in 2 ways - [Create and Manage networks with the Dashboard](with_the_dashboard/create-and-manage-networks-with-the-dashboard.md) -- [Create and Manage networks via CLI](with_the_cli/create-and-manage-networks-via-cli.md) +- [Create and Manage networks via CLI](with_the_CLI/create-and-manage-networks-via-cli.md) Within the network tab you also have the following that you are able to manage @@ -30,7 +30,7 @@ Security Groups can be created and managed within the FlexiHPC dashboard. Howeve - [Create and Manage Security groups with the Dashboard](with_the_dashboard/manage-security-groups-with-the-dashboard.md) -- [Manage Security groups via CLI](with_the_cli/manage-security-groups-via-cli.md) +- [Manage Security groups via CLI](with_the_CLI/manage-security-groups-via-cli.md) ## Floating IPs @@ -42,7 +42,7 @@ If you wish to connect to an instance within the FlexiHPC platform from outside - [Manage Floating IPs with the Dashboard](with_the_dashboard/manage-floating-ips-via-the-dashboard.md) -- [Manage Floating IPs with the CLI](with_the_cli/manage-floating-ips-via-cli.md) +- [Manage Floating IPs with the CLI](with_the_CLI/manage-floating-ips-via-cli.md) ## Static IPs @@ -52,4 +52,4 @@ These network ports can be managed 2 ways - [Create and Manage network ports with the Dashboard](with_the_dashboard/create-and-manage-network-ports-with-the-dashboard.md) -- [Create and manage network ports via CLI](with_the_cli/create-and-manage-network-ports-via-cli.md) +- [Create and manage network ports via CLI](with_the_CLI/create-and-manage-network-ports-via-cli.md) diff --git a/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-network-ports-via-cli.md b/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-network-ports-via-cli.md new file mode 100644 index 0000000..4f9e16c --- /dev/null +++ b/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-network-ports-via-cli.md @@ -0,0 +1,383 @@ +--- +hidden: false +label_names: +- instance +- launch +position: 2 +title: Create and manage network ports via CLI +vote_count: 1 +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. + +First we need to get a few details, `Network ID` we want to connect to the network port to, `the Subnet ID` we want to connect the IP to and the `IP Address` we want to assign to the network port unless you want it to be assigned an IP from the DHCP + +Run the following command to get the `Network ID` + +``` +openstack network list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------------+--------------------------------------+ +| ID | Name | Subnets | ++--------------------------------------+--------------------------------+--------------------------------------+ +| 33d0c11b-b659-4b77-9afc-5676fe965839 | external | 5c2644ad-7253-42f5-ad69-40970b84dea6 | +| 79029286-80ad-4923-a2e6-7d1216a9f2be | rally_verify_88403f86_qmojdKSJ | | +| bcfd4714-ef9c-4c0b-aa58-ad8bcc1a999e | rally_verify_51cf3f2d_mQ0taHVb | | +| d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | NeSI-Training-Test | f5715775-270c-4230-bfa7-fdbdf51352dc | +| d780f680-9640-430f-813f-dbf2128b445c | azimuth-demo | 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | ++--------------------------------------+--------------------------------+--------------------------------------+ +``` + +Take note of the `Network ID` and the `Subnet ID` + +!!! note + For this example we will use the `azimuth-demo` network so the `Network ID: d780f680-9640-430f-813f-dbf2128b445c` and the `Subnet ID: 70dc21e9-d8f4-4232-bda9-2f0a0d508105` + +Should you not know the IP range of the subnet run the following command to get the IP address range from that chosen subnet + +``` +openstack subnet show SUBNET_ID +``` + +Example response below using the `Subnet ID: 70dc21e9-d8f4-4232-bda9-2f0a0d508105` + +``` +openstack subnet show 70dc21e9-d8f4-4232-bda9-2f0a0d508105 +``` + +``` { .sh .no-copy } ++----------------------+--------------------------------------+ +| Field | Value | ++----------------------+--------------------------------------+ +| allocation_pools | 192.168.100.2-192.168.100.254 | +| cidr | 192.168.100.0/24 | +| created_at | 2023-08-11T02:47:17Z | +| description | | +| dns_nameservers | | +| dns_publish_fixed_ip | False | +| enable_dhcp | True | +| gateway_ip | 192.168.100.1 | +| host_routes | | +| id | 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | +| ip_version | 4 | +| ipv6_address_mode | None | +| ipv6_ra_mode | None | +| name | azimuth-demo | +| network_id | d780f680-9640-430f-813f-dbf2128b445c | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| revision_number | 0 | +| segment_id | None | +| service_types | | +| subnetpool_id | None | +| tags | | +| updated_at | 2023-08-11T02:47:17Z | ++----------------------+--------------------------------------+ +``` + +Take note of the `allocation_pools` as that will specify the pool of IP addresses + +## Create a network port + +Run the following command to create a network port + +``` +openstack port create --network NETWORK_ID --description PORT_DESCRIPTION --fixed-ip subnet=SUBNET_ID,ip-address=IP_ADDRESS --enable PORT_NAME +``` + +Using the example IDs we prepared earlier it will look like this + +``` +openstack port create --network d780f680-9640-430f-813f-dbf2128b445c --description wiki-network-port --fixed-ip subnet=70dc21e9-d8f4-4232-bda9-2f0a0d508105,ip-address=192.168.100.60 --enable Wiki-Network-Port-CLI +``` + +We have specified the `Network ID` as the `azimuth-demo` network, with the `Subnet ID` within that network and assigning that network port an IP address of `192.168.100.60`, we also gave it a description and a friendly name. + +The response from the command + +``` { .sh .no-copy } ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| Field | Value | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +| admin_state_up | UP | +| allowed_address_pairs | | +| binding_host_id | None | +| binding_profile | None | +| binding_vif_details | None | +| binding_vif_type | None | +| binding_vnic_type | normal | +| created_at | 2023-08-29T01:29:45Z | +| data_plane_status | None | +| description | wiki-network-port | +| device_id | | +| device_owner | | +| device_profile | None | +| dns_assignment | fqdn='host-192-168-100-60.openstacklocal.', hostname='host-192-168-100-60', ip_address='192.168.100.60' | +| dns_domain | | +| dns_name | | +| extra_dhcp_opts | | +| fixed_ips | ip_address='192.168.100.60', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | +| id | 09e94e3f-ee9e-42f5-851e-a9b4d957b563 | +| ip_allocation | None | +| mac_address | fa:16:3e:05:c9:dd | +| name | Wiki-Network-Port-CLI | +| network_id | d780f680-9640-430f-813f-dbf2128b445c | +| numa_affinity_policy | None | +| port_security_enabled | True | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| propagate_uplink_status | None | +| qos_network_policy_id | None | +| qos_policy_id | None | +| resource_request | None | +| revision_number | 1 | +| security_group_ids | f2f15d6f-2a04-4196-8102-a058042694b3 | +| status | DOWN | +| tags | | +| trunk_details | None | +| updated_at | 2023-08-29T01:29:45Z | ++-------------------------+---------------------------------------------------------------------------------------------------------+ +``` + +Should you not want to assign an IP yourself and allow the DHCP to assign it then run the command without the `ip-address `parameter like below + +``` +openstack port create --network NETWORK_ID --description PORT_DESCRIPTION --fixed-ip subnet=SUBNET_ID --enable PORT_NAME +``` + +Command with response + +``` +openstack port create --network d780f680-9640-430f-813f-dbf2128b445c --description wiki-network-port --fixed-ip subnet=70dc21e9-d8f4-4232-bda9-2f0a0d508105 --enable Wiki-Network-Port-CLI +``` + +``` { .sh .no-copy } ++-------------------------+------------------------------------------------------------------------------------------------------------+ +| Field | Value | ++-------------------------+------------------------------------------------------------------------------------------------------------+ +| admin_state_up | UP | +| allowed_address_pairs | | +| binding_host_id | None | +| binding_profile | None | +| binding_vif_details | None | +| binding_vif_type | None | +| binding_vnic_type | normal | +| created_at | 2023-08-29T01:38:28Z | +| data_plane_status | None | +| description | wiki-network-port | +| device_id | | +| device_owner | | +| device_profile | None | +| dns_assignment | fqdn='host-192-168-100-182.openstacklocal.', hostname='host-192-168-100-182', ip_address='192.168.100.182' | +| dns_domain | | +| dns_name | | +| extra_dhcp_opts | | +| fixed_ips | ip_address='192.168.100.182', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | +| id | d91d923e-a91f-4e00-baa9-eda3ba842dd5 | +| ip_allocation | None | +| mac_address | fa:16:3e:35:5a:e1 | +| name | Wiki-Network-Port-CLI | +| network_id | d780f680-9640-430f-813f-dbf2128b445c | +| numa_affinity_policy | None | +| port_security_enabled | True | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| propagate_uplink_status | None | +| qos_network_policy_id | None | +| qos_policy_id | None | +| resource_request | None | +| revision_number | 1 | +| security_group_ids | f2f15d6f-2a04-4196-8102-a058042694b3 | +| status | DOWN | +| tags | | +| trunk_details | None | +| updated_at | 2023-08-29T01:38:28Z | ++-------------------------+------------------------------------------------------------------------------------------------------------+ +``` + +Running the below command will list the network ports within the project and we should be able to see our newly created one + +``` +openstack port list +``` + +``` { .sh .no-copy } ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| 09e94e3f-ee9e-42f5-851e-a9b4d957b563 | Wiki-Network-Port-CLI | fa:16:3e:05:c9:dd | ip_address='192.168.100.60', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | DOWN | +| 0e1dc631-2c63-43b4-9bd2-fcdfbedb854c | | fa:16:3e:77:0d:c0 | ip_address='10.1.0.5', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | +| 19737c3e-5717-4d19-8717-d362c53f552a | | fa:16:3e:21:99:fa | ip_address='10.1.0.2', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +``` + +!!! note + The full openstack documentation is [here](https://docs.openstack.org/python-openstackclient/pike/cli/command-objects/port.html#port-create) should you need more advanced parameters + +## List network ports + +Run the below command to list all network ports within your project + +``` +openstack port list +``` + +``` { .sh .no-copy } ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| 09e94e3f-ee9e-42f5-851e-a9b4d957b563 | Wiki-Network-Port-CLI | fa:16:3e:05:c9:dd | ip_address='192.168.100.60', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | DOWN | +| 0e1dc631-2c63-43b4-9bd2-fcdfbedb854c | | fa:16:3e:77:0d:c0 | ip_address='10.1.0.5', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | +| 19737c3e-5717-4d19-8717-d362c53f552a | | fa:16:3e:21:99:fa | ip_address='10.1.0.2', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +``` + +## Attach network port to an Instance + +If you also wish to attach the newly created `Network Port` to an instance then you will also need the `Instance ID` + +Running the below will return a list of all instances within your project + +``` +openstack server list +``` + +``` { .sh .no-copy } ++--------------------------------------+---------------------+--------+----------------------------------------------+------------------------------+--------------------+ +| ID | Name | Status | Networks | Image | Flavor | ++--------------------------------------+---------------------+--------+----------------------------------------------+------------------------------+--------------------+ +| 610ee950-cdf8-425d-a3f3-52de500522ee | k8s-worker-node-1 | ACTIVE | NeSI-Training-Test=10.1.0.101, FLEXIHPC_IP | Ubuntu-Focal-20.04 | balanced1.2cpu4ram | +| 10389ba9-15a9-48b0-91f3-b7cbccdce72b | k8s-worker-node-0 | ACTIVE | NeSI-Training-Test=10.1.0.81, FLEXIHPC_IP | Ubuntu-Focal-20.04 | balanced1.2cpu4ram | +| af6fb776-b80e-49b9-a8d4-a1d88b272b63 | k8s-control-plane-0 | ACTIVE | NeSI-Training-Test=10.1.0.176, FLEXIHPC_IP | Ubuntu-Focal-20.04 | balanced1.2cpu4ram | +| 6d1d5418-a70e-4996-a0f5-4f4c03cfd138 | ood-cluster-admin | ACTIVE | NeSI-Training-Test=10.1.0.69, FLEXIHPC_IP | N/A (booted from volume) | devtest1.4cpu4ram | ++--------------------------------------+---------------------+--------+----------------------------------------------+------------------------------+--------------------+ +``` + +Take note of the `Instance ID` + +!!! note + For this example we will use `Instance ID: 6d1d5418-a70e-4996-a0f5-4f4c03cfd138` + +We then want to list our network ports + +``` +openstack port list +``` + +``` { .sh .no-copy } ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| d91d923e-a91f-4e00-baa9-eda3ba842dd5 | Wiki-Network-Port-CLI | fa:16:3e:35:5a:e1 | ip_address='192.168.100.182', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | DOWN | +| f1c54ee3-80c5-468d-a1cb-2828c1fee5cc | | fa:16:3e:ad:6b:06 | ip_address='10.1.0.1', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +``` + +Take note of the `Network Port ID` + +!!! note + For this example we will use `d91d923e-a91f-4e00-baa9-eda3ba842dd5` + +We then run the following command + +``` +openstack server add port INSTANCE_ID NETWORK_PORT_ID +``` + +Command with our example ID’s + +``` +openstack server add port 6d1d5418-a70e-4996-a0f5-4f4c03cfd138 d91d923e-a91f-4e00-baa9-eda3ba842dd5 +``` + +There will be no response from the server so running the below command will display the new network port added to the instance + +``` +openstack server show 6d1d5418-a70e-4996-a0f5-4f4c03cfd138 +``` + +``` { .sh .no-copy } ++-------------------------------------+----------------------------------------------------------------------------+ +| Field | Value | ++-------------------------------------+----------------------------------------------------------------------------+ +| accessIPv4 | | +| accessIPv6 | | +| access_ipv4 | | +| access_ipv6 | | +| addresses | NeSI-Training-Test=10.1.0.69, 163.7.177.243; azimuth-demo=192.168.100.182 | +| adminPass | None | +| admin_password | None | +| availability_zone | nova | +| block_device_mapping | None | +| block_device_mapping_v2 | None | +| compute_host | None | +| config_drive | True | +| created | 2023-07-19T03:45:21Z | +| created_at | 2023-07-19T03:45:21Z | +| description | None | +| disk_config | AUTO | +| fault | None | +| flavor | devtest1.4cpu4ram (devtest1.4cpu4ram) | +| flavorRef | None | +| flavor_id | None | +| has_config_drive | True | +| hostId | f40676c3043f50b6efeeefb163a9d9f7a0994b288b09dfddcdccac9b | +| host_id | f40676c3043f50b6efeeefb163a9d9f7a0994b288b09dfddcdccac9b | +| host_status | None | +| hostname | ood-cluster-admin | + +| launched_at | 2023-07-19T03:45:28.000000 | ++-------------------------------------+----------------------------------------------------------------------------+ +``` + +You should see the additional network port under `addresses` for your instance + +## Delete a network port + +Run the command `openstack port list` and take note of the `Network Port ID` + +``` +openstack port list +``` + +``` { .sh .no-copy } ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| d91d923e-a91f-4e00-baa9-eda3ba842dd5 | Wiki-Network-Port-CLI | fa:16:3e:35:5a:e1 | ip_address='192.168.100.182', subnet_id='70dc21e9-d8f4-4232-bda9-2f0a0d508105' | DOWN | +| f1c54ee3-80c5-468d-a1cb-2828c1fee5cc | | fa:16:3e:ad:6b:06 | ip_address='10.1.0.1', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +``` + +Take note of the ID for that network port + +!!! note + For this example we will use `d91d923e-a91f-4e00-baa9-eda3ba842dd5` + +Then run the below command, supplying the `Network Port ID` you want to delete + +``` +openstack port delete NETWORK_PORT_ID +``` + +Command with our example ID + +``` +openstack port delete d91d923e-a91f-4e00-baa9-eda3ba842dd5 +``` + +There is no response from the server so run `openstack port list` to see the network port has been removed + +``` +openstack port list +``` + +``` { .sh .no-copy } ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +| f1c54ee3-80c5-468d-a1cb-2828c1fee5cc | | fa:16:3e:ad:6b:06 | ip_address='10.1.0.1', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+-----------------------+-------------------+--------------------------------------------------------------------------------+--------+ +``` diff --git a/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-networks-via-cli.md b/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-networks-via-cli.md new file mode 100644 index 0000000..598f739 --- /dev/null +++ b/docs/user-guides/create-and-manage-networks/with_the_CLI/create-and-manage-networks-via-cli.md @@ -0,0 +1,257 @@ +--- +hidden: false +label_names: +- instance +- launch +position: 2 +title: Create and manage network via CLI +vote_count: 1 +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. + +## Create a network + +Running the below command will generate a network without a subnet + +``` +openstack network create NETWORK_NAME +``` + +Our example command with response + +``` +openstack network create wiki-net +``` + +``` { .sh .no-copy } ++---------------------------+--------------------------------------+ +| Field | Value | ++---------------------------+--------------------------------------+ +| admin_state_up | UP | +| availability_zone_hints | | +| availability_zones | | +| created_at | 2023-09-10T21:10:02Z | +| description | | +| dns_domain | | +| id | 15274353-ceae-476c-a374-dc7142a676f4 | +| ipv4_address_scope | None | +| ipv6_address_scope | None | +| is_default | False | +| is_vlan_transparent | None | +| mtu | 8942 | +| name | wiki-net | +| port_security_enabled | True | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| provider:network_type | None | +| provider:physical_network | None | +| provider:segmentation_id | None | +| qos_policy_id | None | +| revision_number | 1 | +| router:external | Internal | +| segments | None | +| shared | False | +| status | ACTIVE | +| subnets | | +| tags | | +| tenant_id | 4f07cc254d6c4471805d49bae1f739b9 | +| updated_at | 2023-09-10T21:10:02Z | ++---------------------------+--------------------------------------+ +``` + +Take note of the `id` that is returned for the new network + +!!! note + Our `id` from above is `15274353-ceae-476c-a374-dc7142a676f4` + +## Create a network subnet + +Running the below command will generate a subnet for the network that you supply the id from + +``` +openstack subnet create SUBNET_NAME --network NETWORK_ID --subnet-range IP_RANGE_CIDR +``` + +Our example command using the id from above will look like the following + +``` +openstack subnet create wiki-subnet --network 15274353-ceae-476c-a374-dc7142a676f4 --subnet-range 192.0.2.0/24 +``` + +``` { .sh .no-copy } ++----------------------+--------------------------------------+ +| Field | Value | ++----------------------+--------------------------------------+ +| allocation_pools | 192.0.2.2-192.0.2.254 | +| cidr | 192.0.2.0/24 | +| created_at | 2023-09-10T21:11:13Z | +| description | | +| dns_nameservers | | +| dns_publish_fixed_ip | False | +| enable_dhcp | True | +| gateway_ip | 192.0.2.1 | +| host_routes | | +| id | ae9277e7-0a2c-4325-8eb1-33ad86eec974 | +| ip_version | 4 | +| ipv6_address_mode | None | +| ipv6_ra_mode | None | +| name | wiki-subnet | +| network_id | 15274353-ceae-476c-a374-dc7142a676f4 | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| revision_number | 0 | +| segment_id | None | +| service_types | | +| subnetpool_id | None | +| tags | | +| updated_at | 2023-09-10T21:11:13Z | ++----------------------+--------------------------------------+ +``` + +## List all networks and subnets + +Running the below command will list all networks within your project + +``` +openstack network list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------------+--------------------------------------+ +| ID | Name | Subnets | ++--------------------------------------+--------------------------------+--------------------------------------+ +| 15274353-ceae-476c-a374-dc7142a676f4 | wiki-net | ae9277e7-0a2c-4325-8eb1-33ad86eec974 | +| 33d0c11b-b659-4b77-9afc-5676fe965839 | external | 5c2644ad-7253-42f5-ad69-40970b84dea6 | +| 79029286-80ad-4923-a2e6-7d1216a9f2be | rally_verify_88403f86_qmojdKSJ | | +| bcfd4714-ef9c-4c0b-aa58-ad8bcc1a999e | rally_verify_51cf3f2d_mQ0taHVb | | +| d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | NeSI-Training-Test | f5715775-270c-4230-bfa7-fdbdf51352dc | +| d780f680-9640-430f-813f-dbf2128b445c | azimuth-demo | 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | ++--------------------------------------+--------------------------------+--------------------------------------+ +``` + +Running the below will list all subnets within your project + +``` +openstack subnet list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| ID | Name | Network | Subnet | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| 5c2644ad-7253-42f5-ad69-40970b84dea6 | external | 33d0c11b-b659-4b77-9afc-5676fe965839 | 163.7.177.0/24 | +| 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | azimuth-demo | d780f680-9640-430f-813f-dbf2128b445c | 192.168.100.0/24 | +| ae9277e7-0a2c-4325-8eb1-33ad86eec974 | wiki-subnet | 15274353-ceae-476c-a374-dc7142a676f4 | 192.0.2.0/24 | +| f5715775-270c-4230-bfa7-fdbdf51352dc | NeSI-Training-Test | d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | 10.1.0.0/24 | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +``` + +## Delete a subnet + +Run the below command to list out all subnets + +``` +openstack subnet list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| ID | Name | Network | Subnet | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| 5c2644ad-7253-42f5-ad69-40970b84dea6 | external | 33d0c11b-b659-4b77-9afc-5676fe965839 | 163.7.177.0/24 | +| 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | azimuth-demo | d780f680-9640-430f-813f-dbf2128b445c | 192.168.100.0/24 | +| ae9277e7-0a2c-4325-8eb1-33ad86eec974 | wiki-subnet | 15274353-ceae-476c-a374-dc7142a676f4 | 192.0.2.0/24 | +| f5715775-270c-4230-bfa7-fdbdf51352dc | NeSI-Training-Test | d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | 10.1.0.0/24 | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +``` + +Take note of the subnet id that you wish to delete + +!!! note + For our example we will use `ae9277e7-0a2c-4325-8eb1-33ad86eec974` + +We then run the following command while supplying it with the id we have chosen to delete + +``` +openstack subnet delete SUBNET_ID +``` + +The server will not give a response if successful so you will need to run `openstack subnet list` to confirm its removal + +``` +openstack subnet list +``` + +Using our example id our command and list looks like the following + +``` +openstack subnet delete ae9277e7-0a2c-4325-8eb1-33ad86eec974 +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| ID | Name | Network | Subnet | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +| 5c2644ad-7253-42f5-ad69-40970b84dea6 | external | 33d0c11b-b659-4b77-9afc-5676fe965839 | 163.7.177.0/24 | +| 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | azimuth-demo | d780f680-9640-430f-813f-dbf2128b445c | 192.168.100.0/24 | +| f5715775-270c-4230-bfa7-fdbdf51352dc | NeSI-Training-Test | d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | 10.1.0.0/24 | ++--------------------------------------+--------------------+--------------------------------------+------------------+ +``` + +## Delete a network + +Run the below command to list all networks + +``` +openstack network list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------------+--------------------------------------+ +| ID | Name | Subnets | ++--------------------------------------+--------------------------------+--------------------------------------+ +| 15274353-ceae-476c-a374-dc7142a676f4 | wiki-net | ae9277e7-0a2c-4325-8eb1-33ad86eec974 | +| 33d0c11b-b659-4b77-9afc-5676fe965839 | external | 5c2644ad-7253-42f5-ad69-40970b84dea6 | +| 79029286-80ad-4923-a2e6-7d1216a9f2be | rally_verify_88403f86_qmojdKSJ | | +| bcfd4714-ef9c-4c0b-aa58-ad8bcc1a999e | rally_verify_51cf3f2d_mQ0taHVb | | +| d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | NeSI-Training-Test | f5715775-270c-4230-bfa7-fdbdf51352dc | +| d780f680-9640-430f-813f-dbf2128b445c | azimuth-demo | 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | ++--------------------------------------+--------------------------------+--------------------------------------+ +``` + +Take note of the network id we want to remove + +!!! note + For our example we will use `15274353-ceae-476c-a374-dc7142a676f4` + +Then run the below command while supplying the id for the network you wish to remove + +``` +openstack network delete NETWORK_ID +``` + +There will be no response from the server when you send the command so will need to list the networks to confirm removal. + +Example command and list response + +``` +openstack network delete 15274353-ceae-476c-a374-dc7142a676f4 +``` + +``` +openstack network list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------------+--------------------------------------+ +| ID | Name | Subnets | ++--------------------------------------+--------------------------------+--------------------------------------+ +| 33d0c11b-b659-4b77-9afc-5676fe965839 | external | 5c2644ad-7253-42f5-ad69-40970b84dea6 | +| 79029286-80ad-4923-a2e6-7d1216a9f2be | rally_verify_88403f86_qmojdKSJ | | +| bcfd4714-ef9c-4c0b-aa58-ad8bcc1a999e | rally_verify_51cf3f2d_mQ0taHVb | | +| d3a7ddb5-6582-42cf-978a-c99b4ed25ad4 | NeSI-Training-Test | f5715775-270c-4230-bfa7-fdbdf51352dc | +| d780f680-9640-430f-813f-dbf2128b445c | azimuth-demo | 70dc21e9-d8f4-4232-bda9-2f0a0d508105 | ++--------------------------------------+--------------------------------+--------------------------------------+ +``` diff --git a/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-floating-ips-via-cli.md b/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-floating-ips-via-cli.md new file mode 100644 index 0000000..8ca912b --- /dev/null +++ b/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-floating-ips-via-cli.md @@ -0,0 +1,143 @@ +--- +label_names: +- instance +- launch +title: Manage Floating IPs via CLI +vote_count: 1 +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. + + +Use the `openstack` commands to manage floating IP addresses. + +## List floating IP address information + +To list all floating IP addresses that are allocated to the current project, run: + +``` +openstack floating ip list +``` + +``` { .sh .no-copy } ++--------------------------------------+---------------------+------------------+--------------------------------------+--------------------------------------+----------------------------------+ +| ID | Floating IP Address | Fixed IP Address | Port | Floating Network | Project | ++--------------------------------------+---------------------+------------------+--------------------------------------+--------------------------------------+----------------------------------+ +| 1c59da88-9b5c-4214-930e-8447cebd3980 | | None | None | 33d0c11b-b659-4b77-9afc-5676fe965839 | 4f07cc254d6c4471805d49bae1f739b9 | ++--------------------------------------+---------------------+------------------+--------------------------------------+--------------------------------------+----------------------------------+ +``` + +## Associate floating IP addresses + +You can assign a floating IP address to a project and to an instance. + +Run the following command to allocate a floating IP address to the current project. By default, the floating IP address is allocated from the `external` pool. The command outputs the allocated IP address: + +``` +openstack floating ip create external +``` + +``` { .sh .no-copy } ++---------------------+--------------------------------------+ +| Field | Value | ++---------------------+--------------------------------------+ +| created_at | 2023-07-27T01:29:31Z | +| description | | +| dns_domain | | +| dns_name | | +| fixed_ip_address | None | +| floating_ip_address | | +| floating_network_id | 33d0c11b-b659-4b77-9afc-5676fe965839 | +| id | 5c8781cd-399b-4b37-8ced-41ca4a38c128 | +| name | | +| port_details | None | +| port_id | None | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| qos_policy_id | None | +| revision_number | 0 | +| router_id | None | +| status | DOWN | +| subnet_id | None | +| tags | [] | +| updated_at | 2023-07-27T01:29:31Z | ++---------------------+--------------------------------------+ +``` + +List all project instances with which a floating IP address could be associated. + +``` +openstack server list +``` + +``` { .sh .no-copy } ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +| ID | Name | Status | Networks | Image | Flavor | ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +| 8b08a4fb-7372-4269-a583-9dbc91779ffe | test-instance-wiki | ACTIVE | NeSI-Training-Test=10.1.0.134 | Ubuntu-Jammy-22.04 | devtest1.2cpu2ram | ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +``` + +Note the server ID to use. + +List ports associated with the selected server. + +``` +openstack port list --device-id SERVER_ID +``` + +``` { .sh .no-copy } ++--------------------------------------+------+-------------------+---------------------------------------------------------------------------+--------+ +| ID | Name | MAC Address | Fixed IP Addresses | Status | ++--------------------------------------+------+-------------------+---------------------------------------------------------------------------+--------+ +| 09c1ebd1-0fa0-40ec-98ef-bae2417f33ef | | fa:16:3e:14:0c:32 | ip_address='10.1.0.134', subnet_id='f5715775-270c-4230-bfa7-fdbdf51352dc' | ACTIVE | ++--------------------------------------+------+-------------------+---------------------------------------------------------------------------+--------+ +``` + +Note the port ID to use. + +Associate an IP address with an instance in the project, as follows: + +``` +openstack floating ip set --port PORT_ID FLOATING_IP_ADDRESS +``` + +For example: + +``` +openstack floating ip set --port 09c1ebd1-0fa0-40ec-98ef-bae2417f33ef +``` + +The instance is now associated with two IP addresses: + +``` +openstack server list +``` + +``` { .sh .no-copy } ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +| ID | Name | Status | Networks | Image | Flavor | ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +| 8b08a4fb-7372-4269-a583-9dbc91779ffe | test-instance-wiki | ACTIVE | NeSI-Training-Test=10.1.0.134, | Ubuntu-Jammy-22.04 | devtest1.2cpu2ram | ++--------------------------------------+---------------------------------------+--------+----------------------------------------------+--------------------------+--------------------+ +``` + +After you associate the IP address and configure security group rules for the instance, the instance is publicly available at the floating IP address. + +## Disassociate floating IP addresses + +To disassociate a floating IP address from an instance: + +``` +openstack floating ip unset --port PORT_ID FLOATING_IP_ADDRESS +``` + +To remove the floating IP address from a project: + +``` +openstack floating ip delete FLOATING_IP_ADDRESS +``` + +The IP address is returned to the pool of IP addresses that is available for all projects. If the IP address is still associated with a running instance, it is automatically disassociated from that instance. diff --git a/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-security-groups-via-cli.md b/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-security-groups-via-cli.md new file mode 100644 index 0000000..9a1bfd6 --- /dev/null +++ b/docs/user-guides/create-and-manage-networks/with_the_CLI/manage-security-groups-via-cli.md @@ -0,0 +1,183 @@ +--- +label_names: +- security-groups +- launch +- cli +title: Manage Security groups via CLI +vote_count: 1 +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. + +## Creating a Security Group + +Run the following command to create a Security Group with a specified name and description. + +``` +openstack security group create --description FRIENDLY_DESCRIPTION NAME_FOR_GROUP +``` + +An example command to create a security group called `My_Wiki_SG` + +``` +openstack security group create --description "A testing group for wiki" My_Wiki_SG +``` + +We can check the security group is created by running + +``` +openstack security group list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +| ID | Name | Description | Project | Tags | ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +| 339bd140-e6a0-4afd-9b24-029c3243e779 | My_Wiki_SG | A testing group for wiki | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| 7200b28f-9089-4797-a094-39f1995e6f0c | SSH Allow All | This is an open SSH that allows anyone to connect to 22 | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| b5d30ed4-13b3-4f7a-bc5a-c48175566ea3 | My-Security-Group | This is my security group | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| f2f15d6f-2a04-4196-8102-a058042694b3 | default | Default security group | 4f07cc254d6c4471805d49bae1f739b9 | [] | ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +``` + +## Create and manage Security Group rules + +You can modify Security Group rules with the `openstack security group rule` command. + +### Create new rules for a group + +Allow access from all IP addresses (specified as IP subnet `0.0.0.0/0` in CIDR notation) for the port `8080` + +``` +openstack security group rule create --proto tcp --dst-port 8080 SECURITY_GROUP_ID +``` + +The command and response looks like the following + +``` +openstack security group rule create --proto tcp --dst-port 8080 339bd140-e6a0-4afd-9b24-029c3243e779 +``` + +``` { .sh .no-copy } ++-------------------------+--------------------------------------+ +| Field | Value | ++-------------------------+--------------------------------------+ +| created_at | 2023-08-10T00:59:36Z | +| description | | +| direction | ingress | +| ether_type | IPv4 | +| id | f0bce470-8d94-453f-9dfa-3e3e34b0c80e | +| name | None | +| normalized_cidr | 0.0.0.0/0 | +| port_range_max | 8080 | +| port_range_min | 8080 | +| project_id | 4f07cc254d6c4471805d49bae1f739b9 | +| protocol | tcp | +| remote_address_group_id | None | +| remote_group_id | None | +| remote_ip_prefix | 0.0.0.0/0 | +| revision_number | 0 | +| security_group_id | 339bd140-e6a0-4afd-9b24-029c3243e779 | +| tags | [] | +| updated_at | 2023-08-10T00:59:36Z | ++-------------------------+--------------------------------------+ +``` + +If you check the rules again, you'll see the new one has been added + +``` +openstack security group rule list 339bd140-e6a0-4afd-9b24-029c3243e779 +``` + +``` { .sh .no-copy } ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| ID | IP Protocol | Ethertype | IP Range | Port Range | Direction | Remote Security Group | Remote Address Group | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| b0f0edd2-7a55-44b4-84a8-9650de36a7ec | None | IPv6 | ::/0 | | egress | None | None | +| f0bce470-8d94-453f-9dfa-3e3e34b0c80e | tcp | IPv4 | 0.0.0.0/0 | 8080:8080 | ingress | None | None | +| f3925a01-5d47-4c55-ac73-1647cca5b739 | None | IPv4 | 0.0.0.0/0 | | egress | None | None | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +``` + +### Delete a Security Group rule + +First, run the following command to view all Security Groups. + +``` +openstack security group list +``` + +``` { .sh .no-copy } ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +| ID | Name | Description | Project | Tags | ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +| 339bd140-e6a0-4afd-9b24-029c3243e779 | My_Wiki_SG | A testing group for wiki | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| 5150840c-9c27-45a9-91a1-61c5978de8ff | https | | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| 7200b28f-9089-4797-a094-39f1995e6f0c | SSH Allow All | This is an open SSH that allows anyone to connect to 22 | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| 8873336a-02e6-4f84-8fd8-5aa3b929f955 | hpc-toolset-docker-ports | Docker Ports used for the HPC Toolset | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| b24e8bef-969a-4938-8b18-0a33769b181d | kubeapi_whitelist | | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| b5d30ed4-13b3-4f7a-bc5a-c48175566ea3 | My-Security-Group | This is my security group | 4f07cc254d6c4471805d49bae1f739b9 | [] | +| f2f15d6f-2a04-4196-8102-a058042694b3 | default | Default security group | 4f07cc254d6c4471805d49bae1f739b9 | [] | ++--------------------------------------+--------------------------+---------------------------------------------------------+----------------------------------+------+ +``` + +Locate the Security Group that you wish to remove a rule from and take note of its ID + +!!! note + For this example we are using `339bd140-e6a0-4afd-9b24-029c3243e779` + +Running the following command will return all rules associated with that security group. + +``` +openstack security group rule list 339bd140-e6a0-4afd-9b24-029c3243e779 +``` + +``` { .sh .no-copy } ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| ID | IP Protocol | Ethertype | IP Range | Port Range | Direction | Remote Security Group | Remote Address Group | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| b0f0edd2-7a55-44b4-84a8-9650de36a7ec | None | IPv6 | ::/0 | | egress | None | None | +| f0bce470-8d94-453f-9dfa-3e3e34b0c80e | tcp | IPv4 | 0.0.0.0/0 | 8080:8080 | ingress | None | None | +| f3925a01-5d47-4c55-ac73-1647cca5b739 | None | IPv4 | 0.0.0.0/0 | | egress | None | None | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +``` + +Take note of the Security Group Rule ID + +!!! note + For this example we will use f0bce470-8d94-453f-9dfa-3e3e34b0c80e + +To delete a rule, run the following command with the correct rule ID. + +``` +openstack security group rule delete f0bce470-8d94-453f-9dfa-3e3e34b0c80e +``` + +Re-run the list command to confirm the rule has been deleted + +``` +openstack security group rule list 339bd140-e6a0-4afd-9b24-029c3243e779 +``` + +``` { .sh .no-copy } ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| ID | IP Protocol | Ethertype | IP Range | Port Range | Direction | Remote Security Group | Remote Address Group | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +| b0f0edd2-7a55-44b4-84a8-9650de36a7ec | None | IPv6 | ::/0 | | egress | None | None | +| f3925a01-5d47-4c55-ac73-1647cca5b739 | None | IPv4 | 0.0.0.0/0 | | egress | None | None | ++--------------------------------------+-------------+-----------+-----------+------------+-----------+-----------------------+----------------------+ +``` + +## Deleting a Security Group + +Run the following to delete a Security Group + +``` +openstack security group delete SECURITY_GROUP_ID +``` + +!!! warning + You cannot delete the `default` Security Group from your project. It's also not possible to delete a Security Group that is assigned to an instance. diff --git a/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-network-ports-with-the-dashboard.md b/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-network-ports-with-the-dashboard.md index a5942ca..7f4c4ae 100644 --- a/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-network-ports-with-the-dashboard.md +++ b/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-network-ports-with-the-dashboard.md @@ -16,7 +16,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
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. @@ -24,7 +24,7 @@ Open the `Project` tab, open the `Network` tab, select the `Networks` category a Click on the `Ports` tab
- ![Alt text](../../assets/images/flexi/network-ports-overview.png) + ![Alt text](../../../assets/images/flexi/network-ports-overview.png)
Then click `Create Port` @@ -85,13 +85,13 @@ There is also the option to assign security groups to this network port as well. We then click on `Create`
- ![Alt text](../../assets/images/flexi/network-ports-create-dialog.png) + ![Alt text](../../../assets/images/flexi/network-ports-create-dialog.png)
This will then create the network port so that we can assign it to a instance later on
- ![Alt text](../../assets/images/flexi/network-ports-added.png) + ![Alt text](../../../assets/images/flexi/network-ports-added.png)
!!! note @@ -104,19 +104,19 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Instances`
- ![Alt text](../../assets/images/flexi/compute-overview.png) + ![Alt text](../../../assets/images/flexi/compute-overview.png)
Under the `Actions` dropdown select `Attach Interface`
- ![Alt text](../../assets/images/flexi/instance-action-menu.png) + ![Alt text](../../../assets/images/flexi/instance-action-menu.png)
Within the `Attach Interface` dialog we have a few options to attach the network port. We can create a new one here or attach a previously created one. @@ -139,7 +139,7 @@ Click `Attach Interface` The instance should now have the new network port attached
- ![Alt text](../../assets/images/flexi/compute-network-port-attached.png) + ![Alt text](../../../assets/images/flexi/compute-network-port-attached.png)
## Detach a network port from an instance @@ -149,19 +149,19 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Instances`
- ![Alt text](../../assets/images/flexi/compute-overview.png) + ![Alt text](../../../assets/images/flexi/compute-overview.png)
Under the `Actions` dropdown select `Detach Interface`
- ![Alt text](../../assets/images/flexi/instance-action-menu.png) + ![Alt text](../../../assets/images/flexi/instance-action-menu.png)
Within the `Detach Interface` dialog select the IP address for the Network port you wish to detach @@ -169,7 +169,7 @@ Within the `Detach Interface` dialog select the IP address for the Network port Click `Detach Interface`
- ![Alt text](../../assets/images/flexi/compute-network-port-removed.png) + ![Alt text](../../../assets/images/flexi/compute-network-port-removed.png)
## Delete a network port @@ -179,7 +179,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
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. @@ -187,7 +187,7 @@ Open the `Project` tab, open the `Network` tab, select the `Networks` category a Click on the `Ports` tab
- ![Alt text](../../assets/images/flexi/network-ports-overview-selected.png) + ![Alt text](../../../assets/images/flexi/network-ports-overview-selected.png)
Select the port you wish to delete with the check box and the `Delete Port` option so become solid. diff --git a/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-networks-with-the-dashboard.md b/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-networks-with-the-dashboard.md index 4ceba2c..fb76290 100644 --- a/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-networks-with-the-dashboard.md +++ b/docs/user-guides/create-and-manage-networks/with_the_dashboard/create-and-manage-networks-with-the-dashboard.md @@ -16,13 +16,13 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Network` tab and select the `Networks` category
- ![Alt text](../../assets/images/flexi/networks-overview.png) + ![Alt text](../../../assets/images/flexi/networks-overview.png)
Click `Create Network` on the right hand side @@ -82,7 +82,7 @@ Within the `Create Network > Subnet Details` dialog you have the following optio Click `Create` and it should start to create your new network
- ![Alt text](../../assets/images/flexi/specific-network-view.png) + ![Alt text](../../../assets/images/flexi/specific-network-view.png)
## Delete a network @@ -92,7 +92,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Network` tab and select the `Networks` category @@ -100,7 +100,7 @@ Open the `Project` tab, open the `Network` tab and select the `Networks` categor Select the network you wish to delete with the check box
- ![Alt text](../../assets/images/flexi/networks-overview-selected.png) + ![Alt text](../../../assets/images/flexi/networks-overview-selected.png)
The `Delete Network` button should become a solid red @@ -111,4 +111,4 @@ Within the `Confirm Delete Network` dialog ensure you have selected the correct Click `Delete Networks` -The network should now be deleted \ No newline at end of file +The network should now be deleted diff --git a/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-floating-ips-via-the-dashboard.md b/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-floating-ips-via-the-dashboard.md index 7fcc4b8..93a60e5 100644 --- a/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-floating-ips-via-the-dashboard.md +++ b/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-floating-ips-via-the-dashboard.md @@ -16,7 +16,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Network` tab and select `Floating IPs` @@ -43,7 +43,7 @@ Within the `Allocate Floating IP` dialog you have the following options Click `Allocate IP`
- ![Alt text](../../assets/images/flexi/floating-ips.png) + ![Alt text](../../../assets/images/flexi/floating-ips.png)
Under `Actions` click `Associate` @@ -59,7 +59,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Network` tab and select `Floating IPs` @@ -68,4 +68,4 @@ Under `Actions` click `Disassociate` Within the `Confrim Disassociate` dialog confirm the IP you are disassociating -Click `Disassociate` \ No newline at end of file +Click `Disassociate` diff --git a/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md b/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md index 4b77541..28e99b3 100644 --- a/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md +++ b/docs/user-guides/create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md @@ -16,7 +16,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Network` tab and select the `Security Groups` category @@ -25,7 +25,7 @@ Open the `Project` tab, open the `Network` tab and select the `Security Groups` 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.
- ![Alt text](../../assets/images/flexi/default-security-group-rules.png) + ![Alt text](../../../assets/images/flexi/default-security-group-rules.png)
There are 2 Egress and 2 Ingress rules, each one is associated with either IPv4 or IPv6. @@ -39,7 +39,7 @@ The 2 Ingress rules allow any other resource within the FlexiHPC project that ha First start by clicking on `Create Security Group`
- ![Alt text](../../assets/images/flexi/security-groups-overview.png) + ![Alt text](../../../assets/images/flexi/security-groups-overview.png)
Within the `Create Security Group` dialog you have the following options. @@ -53,7 +53,7 @@ Within the `Create Security Group` dialog you have the following options. Once those have been filled out hit the `Create Security Group` button and that will take you to the newly created security group
- ![Alt text](../../assets/images/flexi/new-security-group-rules.png) + ![Alt text](../../../assets/images/flexi/new-security-group-rules.png)
## Updating a Security Groups Rules @@ -65,31 +65,31 @@ We have a few ways of adding new rules to the security groups, either with prede Find the security group that you would like to update the rules for and click `Manage Rules` under the `Action` column
- ![Alt text](../../assets/images/flexi/security-group-manage-rules.png) + ![Alt text](../../../assets/images/flexi/security-group-manage-rules.png)
Once in the security group we want to click on `Add Rule` on the top right
- ![Alt text](../../assets/images/flexi/security-group-add-rule.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule.png)
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
- ![Alt text](../../assets/images/flexi/security-group-add-rule-dialog.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule-dialog.png)
There are all ready a few predefined rules that are ready to use if you so chose
- ![Alt text](../../assets/images/flexi/security-group-predefined-rules.png) + ![Alt text](../../../assets/images/flexi/security-group-predefined-rules.png)
For this example we will create an `SSH` rule
- ![Alt text](../../assets/images/flexi/security-group-predefined-rule-example.png) + ![Alt text](../../../assets/images/flexi/security-group-predefined-rule-example.png)
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`. @@ -104,7 +104,7 @@ We have specified the `SSH` Rule, given it a description so it explains what it Clicking `Add` will update the Security group with the newly created rule
- ![Alt text](../../assets/images/flexi/security-group-add-rule-new.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule-new.png)
### Using Custom Rules @@ -112,19 +112,19 @@ Clicking `Add` will update the Security group with the newly created rule Find the security group that you would like to update the rules for and click `Manage Rules` under the `Action` column
- ![Alt text](../../assets/images/flexi/security-group-manage-rules.png) + ![Alt text](../../../assets/images/flexi/security-group-manage-rules.png)
Once in the security group we want to click on `Add Rule` on the top right
- ![Alt text](../../assets/images/flexi/security-group-add-rule.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule.png)
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
- ![Alt text](../../assets/images/flexi/security-group-add-rule-dialog.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule-dialog.png)
For this Example rule we will allow port `6443`. @@ -134,11 +134,11 @@ So the things we need to ensure are Rule has been set to `Custom TCP Rule`, The We will also leave Remote as `CIDR` and the `CIDR` as allow all, as denoted by `0.0.0.0/0`
- ![Alt text](../../assets/images/flexi/security-group-add-rule-custom-example.png) + ![Alt text](../../../assets/images/flexi/security-group-add-rule-custom-example.png)
We click `Add` and our rule is now added to the security group
- ![Alt text](../../assets/images/flexi/security-group-add-custom-rule-new.png) + ![Alt text](../../../assets/images/flexi/security-group-add-custom-rule-new.png)
diff --git a/docs/user-guides/create-and-manage-object-storage/index.md b/docs/user-guides/create-and-manage-object-storage/index.md index 06c7c02..e5b53aa 100644 --- a/docs/user-guides/create-and-manage-object-storage/index.md +++ b/docs/user-guides/create-and-manage-object-storage/index.md @@ -30,6 +30,6 @@ Interacting with the FlexiHPC Object storage can be done a few ways outside of t - [Interacting with the S3 protocol with Boto3](using-boto3-to-interact-with-object-storage.md) -- [Using FlexiHPC object storage for Terraform state file](../launch-and-mange-instances/other_tools/deployment-of-an-instance-with-terraform.md#using-flexihpc-object-storage-to-store-the-terraform-state-file) +- [Using FlexiHPC object storage for Terraform state file](../launch-and-manage-instances/other_tools/deployment-of-an-instance-with-terraform.md#using-flexihpc-object-storage-to-store-the-terraform-state-file) - [Accessing object storage with Cyberduck](using-cyberduck-to-interact-with-object-storage.md) diff --git a/docs/user-guides/create-and-manage-object-storage/with_the_dashboard/create-and-manage-object-storage-with-the-dashboard.md b/docs/user-guides/create-and-manage-object-storage/with_the_dashboard/create-and-manage-object-storage-with-the-dashboard.md index f88aa16..f9b1c76 100644 --- a/docs/user-guides/create-and-manage-object-storage/with_the_dashboard/create-and-manage-object-storage-with-the-dashboard.md +++ b/docs/user-guides/create-and-manage-object-storage/with_the_dashboard/create-and-manage-object-storage-with-the-dashboard.md @@ -16,7 +16,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category @@ -24,7 +24,7 @@ Open the `Project` tab, open the `Object Storage` tab and select the `Containers Click `+ Container`.
- ![Alt text](../../assets/images/flexi/object-storage-overview.png) + ![Alt text](../../../assets/images/flexi/object-storage-overview.png)
Within the `Create Container` dialog you have a few options @@ -52,7 +52,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category @@ -60,7 +60,7 @@ Open the `Project` tab, open the `Object Storage` tab and select the `Containers Select the container you would like to delete and it should highlight with blue
- ![Alt text](../../assets/images/flexi/object-storage-container-overview.png) + ![Alt text](../../../assets/images/flexi/object-storage-container-overview.png)
Hovering over the `Trashcan Icon` should show a tooltip that says *Delete Container* and clicking it should present a `Confirm Delete` dialog. @@ -81,7 +81,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category @@ -89,7 +89,7 @@ Open the `Project` tab, open the `Object Storage` tab and select the `Containers Select the container you would like to delete and it should highlight with blue
- ![Alt text](../../assets/images/flexi/object-storage-container-overview.png) + ![Alt text](../../../assets/images/flexi/object-storage-container-overview.png)
On the far right there should be 3 icons, `Upload File` `+ Folder` and `Delete Item` @@ -97,7 +97,7 @@ On the far right there should be 3 icons, `Upload File` `+ Folder` and `Delete I Click the `Upload File` icon and within the `Upload File` dialog clicking `Choose File` should allow you to browse to the file on your local machine. You are also able to give it a different name should you so choose.
- ![Alt text](../../assets/images/flexi/object-storage-upload-dialog.png) + ![Alt text](../../../assets/images/flexi/object-storage-upload-dialog.png)
Clicking `Upload File` will now begin to upload that file to the object storage container. The time it takes to complete the upload will depend on the file size and the network upload speed. @@ -111,7 +111,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Object Storage` tab and select the `Containers` category @@ -119,7 +119,7 @@ Open the `Project` tab, open the `Object Storage` tab and select the `Containers Select the container you would like to delete and it should highlight with blue
- ![Alt text](../../assets/images/flexi/object-storage-container-overview.png) + ![Alt text](../../../assets/images/flexi/object-storage-container-overview.png)
On the far right there should be 3 icons, `Upload File` `+ Folder` and `Delete Item` diff --git a/docs/user-guides/create-and-manage-volumes/with_the_dashboard/create-and-manage-volumes-with-the-dashboard.md b/docs/user-guides/create-and-manage-volumes/with_the_dashboard/create-and-manage-volumes-with-the-dashboard.md index c128bdd..fa3e5bd 100644 --- a/docs/user-guides/create-and-manage-volumes/with_the_dashboard/create-and-manage-volumes-with-the-dashboard.md +++ b/docs/user-guides/create-and-manage-volumes/with_the_dashboard/create-and-manage-volumes-with-the-dashboard.md @@ -16,7 +16,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -80,7 +80,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -104,7 +104,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -122,7 +122,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -142,7 +142,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -163,7 +163,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Volume` tab and select the `Volumes` category @@ -172,4 +172,4 @@ Select the check boxes for the volumes that you want to delete. Click `Delete Volumes` and confirm your choice. -A message indicates whether the action was successful. \ No newline at end of file +A message indicates whether the action was successful. diff --git a/docs/user-guides/index.md b/docs/user-guides/index.md index ad3ba65..197a361 100644 --- a/docs/user-guides/index.md +++ b/docs/user-guides/index.md @@ -7,7 +7,7 @@ Our platform's building blocks include: `Compute` : Virtual machines optimised for high-performance computational needs. Multiple flavours of CPU and GPU resources to support a range of compute and memory requirements. - → Get started with our [Compute User Guides](launch-and-mange-instances/index.md) + → Get started with our [Compute User Guides](launch-and-manage-instances/index.md) `Images` : Tailored operating systems to meet your research computing and data needs. Ready-to-use options available, as well as capability to create custom images and contribute to a pool of community-developed images. diff --git a/docs/user-guides/launch-and-manage-instances/connect-to-instance-ssh.md b/docs/user-guides/launch-and-manage-instances/connect-to-instance-ssh.md index 92b76ba..a3d5017 100644 --- a/docs/user-guides/launch-and-manage-instances/connect-to-instance-ssh.md +++ b/docs/user-guides/launch-and-manage-instances/connect-to-instance-ssh.md @@ -2,7 +2,7 @@ To use SSH to connect to your instance, use the downloaded keypair file. You will also need to ensure you have created and assigned a `Security group` to your instance that allows connections on port 22. -Read Create and Manage Security Groups via [Dashboard](../create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md) or [CLI](../create-and-manage-networks/with_the_cli/manage-security-groups-via-cli.md) to create one that allows port 22 if you have not done so already. You will then need to add that to the Instance if you havent already via the [Dashboard](with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md#attach-a-security-group) or [CLI](with-the-CLI/manage-security-groups-of-an-Instance-via-the-cli.md#adding-a-security-group-to-an-instance) +Read Create and Manage Security Groups via [Dashboard](../create-and-manage-networks/with_the_dashboard/manage-security-groups-with-the-dashboard.md) or [CLI](../create-and-manage-networks/with_the_CLI/manage-security-groups-via-cli.md) to create one that allows port 22 if you have not done so already. You will then need to add that to the Instance if you havent already via the [Dashboard](with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md#attach-a-security-group) or [CLI](with_the_CLI/manage-security-groups-of-an-Instance-via-the-cli.md#adding-a-security-group-to-an-instance) !!! note The user name is `ubuntu` for the Ubuntu cloud images on FlexiHPC. We have a list of default users for the most common cloud images in [Default user for images](default-user-nesi-images.md) diff --git a/docs/user-guides/launch-and-manage-instances/index.md b/docs/user-guides/launch-and-manage-instances/index.md index ba3fcd6..f5cdbec 100644 --- a/docs/user-guides/launch-and-manage-instances/index.md +++ b/docs/user-guides/launch-and-manage-instances/index.md @@ -17,7 +17,7 @@ FlexiHPC offers 2 ways to Launch and instance on the platform: This is the most user friendly way to get up and running as its all done via the FlexiHPC dashboard. -- [Launch an Instance via CLI](with-the-CLI/launch-an-instance-via-cli.md) +- [Launch an Instance via CLI](with_the_CLI/launch-an-instance-via-cli.md) This is a more advance way of interacting with the FlexiHPC platform. It requires some environment setup however it gives you the most control over the your project within the platform. @@ -31,4 +31,4 @@ FlexiHPC allows you to resize and instance in 2 ways - [Resizing an instance via the dashboard](with_the_dashboard/resizing-an-Instance-via-the-dashboard.md) -- [Resizing an instance via CLI](with-the-CLI/resizing-an-Instance-via-cli.md) +- [Resizing an instance via CLI](with_the_CLI/resizing-an-Instance-via-cli.md) diff --git a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-a-volume.md b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-a-volume.md index 9cf64d7..52c271e 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-a-volume.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-a-volume.md @@ -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/with_the_cli/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). +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/with_the_CLI/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). diff --git a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-an-image.md b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-an-image.md index e5d2a36..1c52e5f 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-an-image.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-from-an-image.md @@ -12,7 +12,8 @@ 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. + 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. We highly recommend that you supply the parameter `--key-name` to allow connections with your SSH key @@ -86,4 +87,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/with_the_cli/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). +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/with_the_CLI/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). diff --git a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-via-cli.md b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-via-cli.md index 4b743a9..ffa87ce 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-via-cli.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_CLI/launch-an-instance-via-cli.md @@ -178,4 +178,4 @@ You can launch an instance from various sources. - [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) +- [Launch an instance from a volume](./launch-an-instance-from-a-volume.md) diff --git a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md index e1590d2..49052ec 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md @@ -14,7 +14,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Instances` @@ -22,7 +22,7 @@ Open the `Project` tab, open the `Compute` tab and select `Instances` Click `Launch Instance`
- ![Alt text](../../assets/images/flexi/instance-overview.png) + ![Alt text](../../../assets/images/flexi/instance-overview.png)
Within the `Launch Instance` dialog box there are the following values: diff --git a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md index 6389acf..081071d 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/manage-security-groups-of-an-Instance-via-the-dashboard.md @@ -14,7 +14,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Instances` then select the compute instance you want to manage. @@ -24,7 +24,7 @@ Open the `Project` tab, open the `Compute` tab and select `Instances` then selec Under the `Actions` menu on the far right, select `Edit Security Groups`
- ![Alt text](../../assets/images/flexi/instance-action-menu.png) + ![Alt text](../../../assets/images/flexi/instance-action-menu.png)
Within the `Edit Instance` dialog you will have 2 columns @@ -36,13 +36,13 @@ Within the `Edit Instance` dialog you will have 2 columns : These are the security groups attached to your instance
- ![Alt text](../../assets/images/flexi/manage-security-groups-dialog.png) + ![Alt text](../../../assets/images/flexi/manage-security-groups-dialog.png)
Clicking the `+` icon from the `All Security Groups` column will add them to the `Instance Security Groups` column
- ![Alt text](../../assets/images/flexi/manage-security-groups-add-dialog.png) + ![Alt text](../../../assets/images/flexi/manage-security-groups-add-dialog.png)
Once the desired `Secuirty Groups` have been added you then click `save` @@ -53,7 +53,7 @@ Once the desired `Secuirty Groups` have been added you then click `save` Under the `Actions` menu on the far right, select `Edit Security Groups`
- ![Alt text](../../assets/images/flexi/instance-action-menu.png) + ![Alt text](../../../assets/images/flexi/instance-action-menu.png)
Within the `Edit Instance` dialog you will have 2 columns @@ -65,13 +65,13 @@ Within the `Edit Instance` dialog you will have 2 columns : These are the security groups attached to your instance
- ![Alt text](../../assets/images/flexi/manage-security-groups-add-dialog.png) + ![Alt text](../../../assets/images/flexi/manage-security-groups-add-dialog.png)
Clicking the `-` icon from the `Instance Security Groups` column will remove it and add it to the `All Security Groups` column
- ![Alt text](../../assets/images/flexi/manage-security-groups-dialog.png) + ![Alt text](../../../assets/images/flexi/manage-security-groups-dialog.png)
Once the desired `Secuirty Groups` have been removed you then click `save` diff --git a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/resizing-an-Instance-via-the-dashboard.md b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/resizing-an-Instance-via-the-dashboard.md index e147964..1f45346 100644 --- a/docs/user-guides/launch-and-manage-instances/with_the_dashboard/resizing-an-Instance-via-the-dashboard.md +++ b/docs/user-guides/launch-and-manage-instances/with_the_dashboard/resizing-an-Instance-via-the-dashboard.md @@ -14,7 +14,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Instances` then select the compute instance you want to resize. @@ -22,7 +22,7 @@ Open the `Project` tab, open the `Compute` tab and select `Instances` then selec Under the `Actions` menu on the far right, select `Resize Instance`
- ![Alt text](../../assets/images/flexi/instance-action-menu.png) + ![Alt text](../../../assets/images/flexi/instance-action-menu.png)
Within the `Resize Instance` dialog, under the `Flavor Choice` tab you have the following options @@ -34,7 +34,7 @@ Within the `Resize Instance` dialog, under the `Flavor Choice` tab you have the : This is the flavor you would like to resize your compute instance too.
- ![Alt text](../../assets/images/flexi/resize-instance-dialog.png) + ![Alt text](../../../assets/images/flexi/resize-instance-dialog.png)
Under the Advanced Options tab @@ -50,7 +50,7 @@ Click `Resize` After a few moments you will be asked to confirm the Resize
- ![Alt text](../../assets/images/flexi/confirm-resize.png) + ![Alt text](../../../assets/images/flexi/confirm-resize.png)
Under the `Actions` menu click `Confirm Resize/Migrate` to confirm and complete the resize. diff --git a/docs/user-guides/uploading-and-managing-Images/with-the-cli/upload-an-image-via-cli.md b/docs/user-guides/uploading-and-managing-Images/with-the-cli/upload-an-image-via-cli.md index fede49e..e41d770 100644 --- a/docs/user-guides/uploading-and-managing-Images/with-the-cli/upload-an-image-via-cli.md +++ b/docs/user-guides/uploading-and-managing-Images/with-the-cli/upload-an-image-via-cli.md @@ -12,7 +12,8 @@ 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. + 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. To upload an image to FlexiHPC we will be using the command `openstack image create` to upload the image. @@ -81,5 +82,4 @@ The command window will process silently as it uploads it to the FlexiHPC platfo !!! note Adding `--wait` to the end of the command will give you a progress bar rather then returning with the status `queued` -We should then be able to use the `id` returned to launch an instance from either the [Dashboard](../../launch-and-mange-instances/with_the_dashboard/launch-an-instance-via-dashboard.md) or the [CLI](../../launch-and-mange-instances/with-the-CLI/launch-an-instance-via-cli.md) - +We should then be able to use the `id` returned to launch an instance from either the [Dashboard](../../launch-and-manage-instances/with_the_dashboard/launch-an-instance-via-dashboard.md) or the [CLI](../../launch-and-manage-instances/with_the_CLI/launch-an-instance-via-cli.md) diff --git a/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/managing-images-via-the-dashboard.md b/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/managing-images-via-the-dashboard.md index 69b8571..1f2e3b2 100644 --- a/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/managing-images-via-the-dashboard.md +++ b/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/managing-images-via-the-dashboard.md @@ -15,7 +15,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Images` @@ -68,4 +68,4 @@ A `Confirm Delete Image` dialog will appear explaining what image you have selec If you are happy to proceed then click `Delete Image` -The image will then be deleted from the project and underlying storage. \ No newline at end of file +The image will then be deleted from the project and underlying storage. diff --git a/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/upload-an-image-via-the-dashboard.md b/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/upload-an-image-via-the-dashboard.md index 450aa86..a74ee49 100644 --- a/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/upload-an-image-via-the-dashboard.md +++ b/docs/user-guides/uploading-and-managing-Images/with-the-dashboard/upload-an-image-via-the-dashboard.md @@ -15,7 +15,7 @@ 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):
- ![Alt text](../../assets/images/flexi/project-selector.png) + ![Alt text](../../../assets/images/flexi/project-selector.png)
Open the `Project` tab, open the `Compute` tab and select `Images` @@ -72,4 +72,4 @@ The following settings can remain blank as they are not needed to upload an imag `Protected` : This setting allows the image to be protected from deletion. -Once we have filled out the required fields we can click `Create Image`, the FlexiHPC platform will then process and save the image to the underlying CEPHS file system. \ No newline at end of file +Once we have filled out the required fields we can click `Create Image`, the FlexiHPC platform will then process and save the image to the underlying CEPHS file system.