Portal intro: Difference between revisions
Jump to navigation
Jump to search
Line 92: | Line 92: | ||
== Requesting Address Space for BGP Use (via Network List) == | == Requesting Address Space for BGP Use (via Network List) == | ||
# From the 'Networks' dropdown menu, go to 'All IPv4 networks', and request a BGP assignment (e.g., 44.31.0.0/16 - BGP Assignments) by clicking on the 'Request Assignment' icon to the right of the listed assignment (green clipboard).<br>[[File:request-bgp-assignment.png|500px]] | |||
# On the 'Request IP Assignment' dialog box, fill out the mandatory fields, agree to the EULA, and click 'Continue'.<br>[[File:request-ip-assignment-for-bgp-original.png|750px]] | |||
## If the size of the address space you're requesting exceeds your IP address limit, you will need to open a ticket to request the additional address space. Under the 'Tickets' dropdown, select 'New support ticket', fill out the 'Create a new support ticket' dialog box accordingly, and click 'Continue'<br>[[File:ticket-for-additional-address-space.png|750px]]<br>You will then get an alert saying that you 'Successfully created a new ticket'.<br>[[File:successfully-requested-ticket.png|750px]]<br>You may be asked to provide more information to successfully get the address space granted. Once you're granted the address space, repeat steps 1 - 2 of this section. | |||
# You should see a 'BGP Information' dialog box on the UI. Fill out the mandatory information, click 'Submit Request',<br>[[File:bgp-information.png|750px]]<br>and you should now see 'Thank you for requesting address space from ARDC' on your UI (see Step 2 under 'Use Case: IPIP Tunnel Mesh, Standalone or Globally Unique Space'). Note that the Justification must be more than 100 characters. | |||
# You can confirm the address has been successfully requested by going to 'Tickets' > 'View my tickets', and your request should be visible in the 'List your tickets' dialog box. Once the ticket has been closed, you should see the allocation listed in your IPv4 networks. <br>[[File:all-ipv4-allocations-by-user.png|500px]]<br>Clicking 'Edit' will bring you to the 'Update Network' dialog box, where you can make appropriate updates, download the EULA, download the Letter of Authorization (LOA), etc (see below).<br>[[File:update-network-v3.2.png|750px]] | |||
== v2.0 Features == | == v2.0 Features == |
Revision as of 19:56, 15 August 2024
ARDC Portal 2.0 Technical Documentation
By Rebecca Key KO4KVG
Version: 3.3 (April 1, 2024)
Accessing the Portal
Go to https://portal.ampr.org, where you should see the following UI:
Registration
- Click on the 'Register' button at the top right of the UI (see 'Accessing the Portal', step 1) or on the 'Register here' button in the 'ARDC New Portal' dialog box. This will take you to the following screen:
- Complete the field for 'What we should call you?:' and click 'Continue'.
- In the dialog box titled 'Registration (Step 2/3)', you will be introduced to help icons ('?') that will provide you useful information throughout the Portal. Click 'Close' to exit the dialog box.
From there, you enter your email address, a username (used to login) and a password, then click 'Continue'. - You should then arrive at a dialog box titled 'Registration (Step 3/3)' that displays the Terms of Use. Read through the Terms of Use (you must scroll all the way to the bottom), and if you agree to the terms and conditions, tick both 'I AM 18 YEARS OF AGE OR OLDER', and 'I accept and agree to the terms of this End User License Agreement', and then click 'I Accept'. Note that if you are under the age of 18, and/or if you do not agree with the Terms of Use, then you will not be able to use the Portal.
- Note: When you log back in on a later date you might get a notice about the addition and/or updates to the End User License Agreement (EULA). For example, if you see a dialog box titled 'The EULA has been updated.', verify that you are 18 or older and if you would like to continue using the Portal, accept the updated EULA.
- Upon accepting the Terms of Use, you should get a message (see below) informing you that the system is sending you an email verification with further instructions. Follow the instructions in this email.
- Once you complete the instructions in the email, you should get a page that looks like the one below, which will have an alert entitled 'You successfully verified your email'. Fill in the information in the 'LOGIN' dialog box and click 'Login'.
- From there, you will be prompted to click 'Continue Registration'.
- Once you click 'Continue Registration', you will arrive at the screen below. Select your type of registration (individual licensed radio amateur, individual non-licensed radio amateur, or organization) and click the 'Continue' button.
- Once you click 'Continue', you will be brought to a page where you will be asked to provide more information.
- Provide the required information (and any optional information you prefer to share), read and agree to the 'Terms and Conditions', and click the 'Continue' button. You should then see a dialog box prompting you to verify your call sign.
Click 'Close', and you will then see a page that shows 'Registration Complete'. - To add and verify your call sign (i.e., if you registered as an 'individual licensed radio amateur'), go to the 'Account' dropdown menu and select 'Callsigns'. Your primary call sign should show up in the 'Update your callsigns' dialog box. Clicking 'Add a callsign' in the top left-hand corner allows you to add any additional call signs you may have.
- On the 'Update your callsigns' UI, click 'Verify'. This will take you to a screen that details the process of verification.
- Click on the green 'Verify' button: you should see an alert saying 'Your request to verify your callsign [$callsign] has been submitted', which will create a ticket for the Portal admins to verify your call sign.
You can check the ticket by going to the 'Tickets' dropdown menu, selecting 'View my tickets', where you see it listed. To see the details of the ticket, click 'View'.
- Note that once your call sign has been verified, you will no longer see the ticket in the list. Alternatively, you can confirm that your call sign has been verified by going to 'Account' > 'Callsigns', and the status of your call sign verification will be displayed in the 'Update your callsigns' dialog box. Once your call sign has been verified, you will be able to request address space.
- Note that once your call sign has been verified, you will no longer see the ticket in the list. Alternatively, you can confirm that your call sign has been verified by going to 'Account' > 'Callsigns', and the status of your call sign verification will be displayed in the 'Update your callsigns' dialog box. Once your call sign has been verified, you will be able to request address space.
Requesting Address Space (Beginner Friendly Steps)
This series of steps is aimed at users who are either new to requesting 44Net address space, need a refresher, or would like to streamline the process. Otherwise, you can also request address space via the Network list in the 'Requesting Address Space (via Network List)' and 'Requesting Address Space for BGP Use (via Network List)' sections below.
- Under the 'Networks' menu, select 'Request addresses'. Note that you can also request address space on the Dashboard by clicking 'Request address space'.
- You should see a dialog box entitled 'Request Address Space'. Select your address type (should be IPv4, as IPv6 is not currently available), use case, and click 'Continue'. Please see the below instructions for your particular use case.
Use Case: IPIP Tunnel Mesh, Standalone or Globally Unique Space
- If you selected IPIP tunnel mesh or Globally unique space as your use case, you will see a dialog box entitled 'Request IP Assignment'. Fill out the 'Request IP Assignment' dialog box with the required information; and click 'Continue'.
- You will then see the following note thanking you for requesting address space from ARDC, which includes detailed information about next steps.
- Once your address space has been assigned, you can proceed to step 6 under 'Requesting Address Space (via Network List)'.
Use Case: BGP Direct Announce
- If you selected 'BGP Direct Announce' as your use case, you will see a dialog box entitled 'Request IP Assignment'. Fill out the 'Request IP Assignment' dialog box with the required information, agree to the EULA, and click 'Continue'.
- If the size of the address space you're requesting exceeds your IP address limit, you will get the warning 'This request would exceed your IP address limit.'
Click 'Please view this page for information on how to increase your limits', which will provide detailed information for 'How to request more address space', along with links to learn more information about Level of Trust (LoT) and Classless Inter-Domain Routing (CDIR). - Follow step 2-1 under 'Requesting Address Space for BGP Use (via Network List)'. Please note that you may be asked to provide more information to increase your LoT to acquire more address space.
- If the size of the address space you're requesting exceeds your IP address limit, you will get the warning 'This request would exceed your IP address limit.'
- Once your additional address space has been allocated, go back to 'Networks' > 'Request Addresses', select your address type 'BGP direct announce' for your use case, and proceed with step 3 under 'Requesting Address Space for BGP Use (via Network List)'.
Other Use Cases
Selecting any of the below use cases will give you a dialog box that provides more details about the network:
- AREDN
- HAMNET
- HamWAN
Use Cases Coming Soon
- POP VPN
- Emergency communications
- General address assignment
Requesting Address Space (via Network List)
- Under the 'Networks' menu, select 'All IPv4 Networks'.
- In the 'List IPv4 Networks' dialog box, click the + sign to expand a line, or use the 'Expand All' button.
- Scroll to look for the address space you are looking for (e.g., 44.63.0.0/16 - IPIP Mesh Assignments) and click on the green clipboard icon to the right of the assignment to request an assignment.
- Fill out the 'Request IP Assignment' dialog box with the required information, click 'Continue'.
You will see the dialog box titled 'Thank you for requesting address space from ARDC' (see step 2 under 'Use Case: IPIP Tunnel Mesh, Standalone, or Globally Unique Space'), which includes detailed information about next steps. - To confirm that your address space has been successfully requested, you can go to 'Tickets' > 'View my tickets' to see if the request is in your ticket list.
Note that you may be asked to provide more information to the Ticket Handler about your request before your address space is assigned. - Once your space has been assigned (and the associated ticket has been closed), you can view your IPv4 networks by going to 'Networks' > 'my IPv4 networks', where your network detail(s) will be provided.
Adding DNS Records to a Subdomain
- On the 'DNS' dropdown menu, select 'My subdomains' and then click Request a subdomain' in the 'My subdomains' dialog box.
- Choose your domain, determine a name for your subdomain (i.e., most likely your call sign), click 'Create request', and you should see a dialog box titled 'Thank you for requesting a new
subdomain!' (see below), along with an overview of next steps. You can verify that your subdomain has been requested by viewing your tickets ('Tickets' > 'View my tickets'). - Once the ticket for creating your subdomain has been closed (see below),
you can verify that your subdomain has been created by going to 'DNS' > 'My subdomains', and your subdomain should appear in the 'Subdomains' dialog box. - Once your subdomain has been created, you can add DNS records by going to 'DNS' > 'My subdomains', and click the icon under 'Actions' in the 'Subdomains' dialog box (see step 3 above).
- In the 'Resource records for $subdomain.ampr.org', click 'Add a resource record'.
- In the 'Create resource record for $subdomain.ampr.org', select the record type, and click 'Next' (see below).
- Add the details relevant to the record type and ensure that Active is checked, click 'Create',
and you should get an alert that says 'Subdomain Record created successfully'. - You can verify that your record has been created by going to 'DNS' > 'My records' and look for the record that is associated with your subdomain.
Creating a Gateway
- Go to 'Networks' > 'My gateways' and click 'Create a Gateway' in the 'My Gateways' dialog box.
- In the 'Create new Gateway' dialog box, fill out all required fields, click 'Add', and you should get an alert saying 'Gateway created successfully.'
- To add a subnet to your gateway, click the edit button under 'Actions' (see step 2 above). You will be taken to an 'Update Gateway' dialog box, which includes information about your gateway. Click 'Add New Network'.
- You will then see an 'Add New Network' dialog box (see below). Select a network from your list of networks; leave 'Find Network' field blank; and then click 'Add'. You should see an alert titled 'Network Successfully Linked to this Gateway' (see below). You can verify that your network has been added by clicking 'View My Gateways' and seeing said gateway under 'My Gateways' (see below).
- If you would like to add someone else's network using their unique code, click 'Add New Network', which will take you to the 'Add New Network' dialog box. Fill out the required information, and click 'Find'. You should have a 44Net address displaying in the 'Network found' field. Click 'Add', and you should see an alert titled 'Network Successfully Linked to this Gateway' (see step 4 above).
- You can add or remove linked networks by clicking the 'Add New Network' or 'Unlink' button, respectively (see steps 3 and 4 above).
Requesting Address Space for BGP Use (via Network List)
- From the 'Networks' dropdown menu, go to 'All IPv4 networks', and request a BGP assignment (e.g., 44.31.0.0/16 - BGP Assignments) by clicking on the 'Request Assignment' icon to the right of the listed assignment (green clipboard).
- On the 'Request IP Assignment' dialog box, fill out the mandatory fields, agree to the EULA, and click 'Continue'.
- If the size of the address space you're requesting exceeds your IP address limit, you will need to open a ticket to request the additional address space. Under the 'Tickets' dropdown, select 'New support ticket', fill out the 'Create a new support ticket' dialog box accordingly, and click 'Continue'
You will then get an alert saying that you 'Successfully created a new ticket'.
You may be asked to provide more information to successfully get the address space granted. Once you're granted the address space, repeat steps 1 - 2 of this section.
- If the size of the address space you're requesting exceeds your IP address limit, you will need to open a ticket to request the additional address space. Under the 'Tickets' dropdown, select 'New support ticket', fill out the 'Create a new support ticket' dialog box accordingly, and click 'Continue'
- You should see a 'BGP Information' dialog box on the UI. Fill out the mandatory information, click 'Submit Request',
and you should now see 'Thank you for requesting address space from ARDC' on your UI (see Step 2 under 'Use Case: IPIP Tunnel Mesh, Standalone or Globally Unique Space'). Note that the Justification must be more than 100 characters. - You can confirm the address has been successfully requested by going to 'Tickets' > 'View my tickets', and your request should be visible in the 'List your tickets' dialog box. Once the ticket has been closed, you should see the allocation listed in your IPv4 networks.
Clicking 'Edit' will bring you to the 'Update Network' dialog box, where you can make appropriate updates, download the EULA, download the Letter of Authorization (LOA), etc (see below).