-
Notifications
You must be signed in to change notification settings - Fork 189
F OpenNebula/one#6756: Add Scaleway provider docs #3112
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -632,6 +632,7 @@ sata | |
| saveas | ||
| scalability | ||
| scalable | ||
| scaleway | ||
| sched | ||
| schedadd | ||
| scheddelete | ||
|
|
||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
52 changes: 52 additions & 0 deletions
52
source/provision_clusters/edge_clusters/scaleway_cluster.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| .. _scaleway_cluster: | ||
|
|
||
| ================================================================================ | ||
| Scaleway Edge Cluster | ||
| ================================================================================ | ||
|
|
||
| Edge Cluster Types | ||
| ================================================================================ | ||
|
|
||
| Equinix supports **metal** edge clusters that use bare-metal instances to create OpenNebula Hosts. Metal provisions can run the **LXC** or **KVM** hypervisors. | ||
|
|
||
| Scaleway Edge Cluster Implementation | ||
| ================================================================================ | ||
|
|
||
| An Edge Cluster in Scaleway creates the following resources: | ||
|
|
||
| * **Scaleway Elastic Metal Device**: Host to run virtual machines. | ||
| * **Scaleway VPC**: it creates an isolated virtual network for all the deployed resources. | ||
| * **Scaleway private subnet**: it allows communication between VMs that are running in the provisioned Hosts. | ||
| * **Scaleway internet public gateway**: it allows VMs to have public connectivity over Internet. | ||
|
|
||
|
|
||
| The network model is implemented in the following way: | ||
|
|
||
| * **Public Networking**: this is implemented using elastic IPs from Scaleway and the IPAM driver from OpenNebula. When the virtual network is created in OpenNebula, the elastic IPs are requested from Scaleway. Then, inside the Host, IP forwarding rules are applied so the VM can communicate over the public IP assigned by Scaleway. | ||
|
|
||
| * **Private Networking**: this is implemented using (BGP-EVPN) and VXLAN. | ||
|
|
||
| |image_cluster| | ||
|
|
||
| OpenNebula resources | ||
| ================================================================================ | ||
|
|
||
| The following resources, associated to each Edge Cluster, will be created in OpenNebula: | ||
|
|
||
| 1. Cluster - containing all other resources. | ||
| 2. Hosts - for each Scaleway Elastic Metal Device. | ||
| 3. Datastores - image and system datastores with SSH transfer manager using first instance as a replica. | ||
| 4. Virtual network - for public networking. | ||
| 5. Virtual network template - for private networking. | ||
|
|
||
| Operating Providers & Edge Clusters | ||
| ================================================================================ | ||
|
|
||
| Refer to the :ref:`cluster operation guide <cluster_operations>` to check all of the operations needed to create, manage, and delete an Edge Cluster. Refer to the :ref:`providers guide <provider_operations>` to check all of the operations related to providers. | ||
|
|
||
| You can also manage AWS and Equinix Clusters using the OneProvision GUI in Sunstone. | ||
|
|
||
| |image_fireedge| | ||
|
|
||
| .. |image_cluster| image:: /images/scaleway_deployment.png | ||
| .. |image_fireedge| image:: /images/oneprovision_fireedge.png |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,66 @@ | ||
| .. _scaleway_provider: | ||
|
|
||
| ================================================================================ | ||
| Scaleway Provider | ||
| ================================================================================ | ||
|
|
||
| A Scaleway provider contains the credentials to interact with Scaleway and also the location to deploy your Provisions. OpenNebula comes with three pre-defined providers in the following regions: | ||
|
|
||
| * PAR-1 (France - Paris) | ||
| * NL-AMS-1 (Netherlands - Amsterdam) | ||
| * PL-WAW-3 (Poland - Warsaw) | ||
|
|
||
| In order to define a Scaleway provider, you need the following information: | ||
|
|
||
| * **Credentials**: these are used to interact with the remote provider. You need to provide ``access_key``, ``secret_key`` and ``project_id``. You can follow `this guide <https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys//>`__ to get this data. | ||
| * **Zone**: this is the location in the world where the resources are going to be deployed. All the available `zones are listed here <https://www.scaleway.com/en/docs/console/account/reference-content/products-availability/>`__. | ||
| * **Offers and OS**: these define the capacity of the resources that are going to be deployed and the operating system that is going to be installed on them. | ||
|
|
||
| .. warning:: Please note even though Scaleway support multiple OSs, the automation tools are tailored to works with ``Ubuntu 22.04``. If you use another OS, please be aware that it might required some adjustments, and things might not work as expected. Avoid using a different OS in production environment unless you've properly tested it before. | ||
|
|
||
| How to Create an Scaleway Provider | ||
| ================================================================================ | ||
|
|
||
| To add a new provider you need to write the previous data in YAML template: | ||
|
|
||
| .. prompt:: bash $ auto | ||
|
|
||
| $ cat provider.yaml | ||
| name: 'scaleway' | ||
|
|
||
| description: 'Provision cluster in Scaleway Paris' | ||
| provider: 'scaleway' | ||
|
|
||
| plain: | ||
| provision_type: 'metal' | ||
|
|
||
| connection: | ||
| access_key: 'Scaleway Access Key' | ||
| secret_key: 'Scaleway Secret Key' | ||
| project_id: 'Scaleway Project ID' | ||
| zone: 'fr-par-1' | ||
|
|
||
| inputs: | ||
| - name: 'scw_baremetal_os' | ||
| type: 'text' | ||
| default: 'Ubuntu' | ||
| description: 'Scaleway ost operating system' | ||
|
|
||
| - name: 'scw_offer' | ||
| type: 'list' | ||
| default: 'EM-A115X-SSD' | ||
| description: 'Scaleway server capacity' | ||
| options: | ||
| - 'EM-A115X-SSD' | ||
|
|
||
|
|
||
| Then you just need to use the command ``oneprovider create``: | ||
|
|
||
| .. prompt:: bash $ auto | ||
|
|
||
| $ oneprovider create provider.yaml | ||
| ID: 0 | ||
|
|
||
| The providers' templates are located in ``/usr/share/one/oneprovision/edge-clusters/metal/providers/scaleway``. You just need to enter valid credentials. | ||
|
|
||
| .. include:: customize.txt |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@vickmp in this file line 51 points to
images/scaleway_deployment.pngbut the actual filename isimages/scaleway-deployment.jpg. If you could change the image file name and also transform the image into .png for consistency