diff --git a/macros/general/troubleshooting-ticket.mdx b/macros/general/troubleshooting-ticket.mdx index 7d4f7445d0..43e0acc99d 100644 --- a/macros/general/troubleshooting-ticket.mdx +++ b/macros/general/troubleshooting-ticket.mdx @@ -11,19 +11,19 @@ If you still cannot solve your problem, [open a support ticket](/account/how-to/ - Log / trace of the error (if possible) - Screenshots (using our secure [pastebin tool](https://privatebin.iliad.fr/)) - HTTP status code (if applicable) - - Request type (PUT, GET, etc., if applicable) + - Request type (PUT, GET, etc., if applicable) - - - \ No newline at end of file + diff --git a/pages/account/how-to/change-console-appearance.mdx b/pages/account/how-to/change-console-appearance.mdx index f6ad735666..47a8cb7a56 100644 --- a/pages/account/how-to/change-console-appearance.mdx +++ b/pages/account/how-to/change-console-appearance.mdx @@ -12,6 +12,8 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + You can choose the color scheme of the [Scaleway console](/account/concepts/#console) according to your preferences. We offer a light, dark, darker, or system-based color scheme. @@ -19,7 +21,7 @@ You can choose the color scheme of the [Scaleway console](/account/concepts/#con This feature is currently not available for [IAM Members](/iam/concepts/#member). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/account/how-to/change-language.mdx b/pages/account/how-to/change-language.mdx index b2e0cd6cc2..ed16fcb1c7 100644 --- a/pages/account/how-to/change-language.mdx +++ b/pages/account/how-to/change-language.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + You can choose which language you would like to view the [Scaleway console](/account/concepts/#console) in. This language will also be used for any marketing and product communications Scaleway sends you. - + - A [Scaleway account](https://console.scaleway.com) diff --git a/pages/account/how-to/change-password.mdx b/pages/account/how-to/change-password.mdx index aa11ad610f..4cb9bfbf6f 100644 --- a/pages/account/how-to/change-password.mdx +++ b/pages/account/how-to/change-password.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to change your [Scaleway account](https://console.scaleway.com) password. - + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/account/how-to/close-account.mdx b/pages/account/how-to/close-account.mdx index 3adbde6ef9..539df1ce9b 100644 --- a/pages/account/how-to/close-account.mdx +++ b/pages/account/how-to/close-account.mdx @@ -12,18 +12,23 @@ dates: categories: - console --- +import CloseVsErase from '@macros/console/close-vs-erase.mdx' +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-account-closed.webp' + If you do not want to use Scaleway services anymore, you can close your account and/or [erase your personal data](/account/how-to/manage-my-personal-data-gdpr/#how-to-erase-your-account-and-personal-data). ## Closing your account or erasing your personal data: what’s the difference - + ## How to close your account Closing your account will permanently delete your Organization’s servers, resources, services, and backups. However, you keep access to the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Ownership](/iam/concepts/#owner) of the Organization you intend to delete @@ -46,4 +51,4 @@ Closing your account will permanently delete your Organization’s servers, reso When your account is closed, you can still access the Scaleway console. A red banner at the top navigation bar will display to inform you that your account has been closed. If you want to reopen it, you can [open a support ticket](https://console.scaleway.com/support/tickets/create). - \ No newline at end of file + \ No newline at end of file diff --git a/pages/account/how-to/configure-support-plans.mdx b/pages/account/how-to/configure-support-plans.mdx index 63aa2c6b10..e498239ae1 100644 --- a/pages/account/how-to/configure-support-plans.mdx +++ b/pages/account/how-to/configure-support-plans.mdx @@ -12,8 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-support-plans-overview.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +33,7 @@ The default support plan for an Organization is the **Basic** plan, but it can b Alternatively, click the question mark icon on the top menu to go directly to the console Help Center. 2. Click **Upgrade plan**. You are redirected to the **Support plans** tab of the console Help Center. - + 3. Click **Select** to select a plan. A pop-up displays a disclaimer message informing you that: diff --git a/pages/account/how-to/create-an-account.mdx b/pages/account/how-to/create-an-account.mdx index 76d6e99f29..e664d4bc28 100644 --- a/pages/account/how-to/create-an-account.mdx +++ b/pages/account/how-to/create-an-account.mdx @@ -12,7 +12,9 @@ dates: categories: - console --- +import CreateAccount from '@macros/console/create-account.mdx' + Scaleway is a complete cloud ecosystem, offering a single way for you to create, deploy and scale your infrastructure in the cloud. Create your Scaleway account to gain access to the [Scaleway console](/account/concepts/#console) and [Scaleway API](https://www.scaleway.com/en/developers/api/), and deploy our products and services with ease. - + diff --git a/pages/account/how-to/log-in-to-the-console.mdx b/pages/account/how-to/log-in-to-the-console.mdx index b765795517..fab197e87c 100644 --- a/pages/account/how-to/log-in-to-the-console.mdx +++ b/pages/account/how-to/log-in-to-the-console.mdx @@ -12,8 +12,13 @@ dates: categories: - console --- +import LoginMember from '@macros/iam/login-member.mdx' +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-magic-link-email.webp' + + + - A [Scaleway](https://www.scaleway.com/en/) account @@ -26,7 +31,7 @@ Instead of using your password, you can use a **Magic Link** to authenticate you A magic link will be sent to your email inbox. 3. Check your email inbox for an email with the subject **Scaleway - Passwordless Authentication** and open it. 4. Click **Authenticate Myself** to connect to the Scaleway console. - + You will be redirected to and logged into your management console. @@ -49,7 +54,7 @@ Scaleway provides Single Sign-On (SSO) options for a seamless login experience. If you were added to a Scaleway Organization as an [IAM Member](/iam/concepts#members), you must follow a dedicated login process. - + ## How to log in using MFA diff --git a/pages/account/how-to/manage-my-personal-data-gdpr.mdx b/pages/account/how-to/manage-my-personal-data-gdpr.mdx index 0aef3108bc..e6f782e445 100644 --- a/pages/account/how-to/manage-my-personal-data-gdpr.mdx +++ b/pages/account/how-to/manage-my-personal-data-gdpr.mdx @@ -12,10 +12,13 @@ dates: categories: - console --- +import CloseVsErase from '@macros/console/close-vs-erase.mdx' +import Requirements from '@macros/iam/requirements.mdx' + Scaleway makes it easy for you to manage your personal data and privacy via the console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -66,13 +69,13 @@ If you do not want to use Scaleway services anymore, you can [close your account ### Closing your account or erasing your personal data: what’s the difference? - + ### How to erase your personal data Erasing your account and personal data will permanently delete your Organization’s servers, resources, services, backups, and all data related to your account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Ownership](/iam/concepts/#owner) of the Organization you intend to delete diff --git a/pages/account/how-to/manage-notifications.mdx b/pages/account/how-to/manage-notifications.mdx index 3dc4e0dd5d..e783c42301 100644 --- a/pages/account/how-to/manage-notifications.mdx +++ b/pages/account/how-to/manage-notifications.mdx @@ -12,17 +12,21 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-notif-icon.webp' + The **notification manager** allows you to configure different types of notifications about Organization events, for the users in your Organization. These events include incidents, technical issues or maintenance, security alerts and billing. The notification manager also provides shortcuts to your [Budget alerts](/billing/how-to/use-billing-alerts/), [Cockpit alerts](/cockpit/how-to/enable-alert-manager/), and the Scaleway [status page](https://status.scaleway.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) ## How to notify users in your Organization 1. Click the bell icon, or **notification manager** icon, in the top-right menu of the Scaleway console. You are directed to the Notification Manager page. - + 2. Scroll to the **User notifications** section. 3. Check the box(es) next to the email of the user for who you want to set up the notifications. Four [types of notifications](#types-of-notifications) are available: **Incident**, **Technical**, **Security** and **Billing**. diff --git a/pages/account/how-to/open-a-support-ticket.mdx b/pages/account/how-to/open-a-support-ticket.mdx index 87bc71eb72..a1d4279e28 100644 --- a/pages/account/how-to/open-a-support-ticket.mdx +++ b/pages/account/how-to/open-a-support-ticket.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway provides 24/7 basic technical support by ticket for free. You can contact our support team directly from the console. You can also [upgrade your support level](/account/how-to/configure-support-plans/) to benefit from phone support and a dedicated account manager. - + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/account/how-to/recover-a-lost-password.mdx b/pages/account/how-to/recover-a-lost-password.mdx index 26c4b0b335..70a28d9d76 100644 --- a/pages/account/how-to/recover-a-lost-password.mdx +++ b/pages/account/how-to/recover-a-lost-password.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + If you forget or lose the password to your [Scaleway account](https://console.scaleway.com), there are several methods you can use to regain access. - + - A [Scaleway](https://www.scaleway.com/en/) account diff --git a/pages/account/how-to/report-abuse.mdx b/pages/account/how-to/report-abuse.mdx index f0710c2d5b..26df04af7c 100644 --- a/pages/account/how-to/report-abuse.mdx +++ b/pages/account/how-to/report-abuse.mdx @@ -12,8 +12,10 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/account/how-to/resolve-abuse.mdx b/pages/account/how-to/resolve-abuse.mdx index fb43769df7..41393b1b02 100644 --- a/pages/account/how-to/resolve-abuse.mdx +++ b/pages/account/how-to/resolve-abuse.mdx @@ -12,6 +12,8 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + Abuses are complaints regarding the use of Scaleway services for illegal behavior or hosting of illegal content. Abuse reports for the same issue on the same resource within a given time frame are grouped by case. @@ -21,7 +23,7 @@ However, Scaleway reserves the right to immediately suspend the infringing servi If you encounter any issue with the resolution of an abuse, ensure that you contact the abuse team by opening a [support ticket](https://console.scaleway.com/support/tickets/create) directly from your console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/account/how-to/switch-account-to-corporate.mdx b/pages/account/how-to/switch-account-to-corporate.mdx index d5e72056db..27f252706e 100644 --- a/pages/account/how-to/switch-account-to-corporate.mdx +++ b/pages/account/how-to/switch-account-to-corporate.mdx @@ -12,6 +12,11 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-billing-personal-info.webp' +import image2 from './assets/scaleway-billing-corporate-info.webp' + The [Scaleway console](https://console.scaleway.com) allows you to choose between two types of accounts, Personal and Corporate. All users are given the possibility to select one or the other option when first signing up for a Scaleway account. If you signed up for a personal account and need to convert to a corporate one, follow these instructions. @@ -19,15 +24,15 @@ The [Scaleway console](https://console.scaleway.com) allows you to choose betwee Switching to a corporate account is permanent. You will not be able to switch back to a personal account once the conversion to corporate is completed. - + - A Scaleway account logged into the [console](https://console.scaleway.com) 1. Click **Billing** in the top right drop-down menu. The **Billing** dashboard displays. 2. Click the **Payment and billing tab**. 3. Scroll down to billing information, then click **Edit**. A pop-up with your billing information displays. - + 4. Check the box at the top to confirm you wish to have a corporate account. A new form displays. - + 5. Enter your company's information, including name, address, and valid VAT number. European B2B customers are exempted from VAT, as long as they provide a registered VAT number. Learn more about our [tax policy](/billing/faq/#do-the-prices-shown-on-the-website-include-eu-vat). diff --git a/pages/account/how-to/use-2fa.mdx b/pages/account/how-to/use-2fa.mdx index 3496478c77..10de71cd45 100644 --- a/pages/account/how-to/use-2fa.mdx +++ b/pages/account/how-to/use-2fa.mdx @@ -12,12 +12,14 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + You can enable multifactor authentication on your Scaleway account for heightened security. Once enabled, an additional security code generated by your phone is required to access your account. Multifactor authentication provides extra layers of security. In addition to your password (the first factor), other factors (such as an MFA app) are required to access your account. Even in the event of a leaked password, your account is protected. - + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -51,7 +53,7 @@ Next time you log in to your Scaleway account, you will be prompted for an MFA c If you no longer have access to the device in which you set up your MFA, you can update your MFA information and set it up via the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/account/how-to/use-the-search-bar.mdx b/pages/account/how-to/use-the-search-bar.mdx index 0b88ab6bdd..98e0077fb7 100644 --- a/pages/account/how-to/use-the-search-bar.mdx +++ b/pages/account/how-to/use-the-search-bar.mdx @@ -12,10 +12,12 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + The **search bar** functionality of the Scaleway console allows you to quickly find Scaleway resources and products. - + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/account/how-to/verify-identity.mdx b/pages/account/how-to/verify-identity.mdx index 2229570451..1c66f503f5 100644 --- a/pages/account/how-to/verify-identity.mdx +++ b/pages/account/how-to/verify-identity.mdx @@ -12,18 +12,23 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-add-id-document.webp' +import image2 from './assets/scaleway-choose-country-of-issue.webp' + Verifying your identity allows you to [unlock resource quotas](/organizations-and-projects/additional-content/organization-quotas/) and fully benefit from the console's features and products. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A valid payment method linked to your account 1. Click **Add ID document** under **(Optional) Verify my ID document** on the [Organization dashboard](https://console.scaleway.com/organization/). You can also verify your identity from the [Settings tab](https://console.scaleway.com/organization/settings) of your Organization dashboard. - + 2. Click **Start** to proceed. - + Use a valid government-issued photo ID. A residence permit is also considered a valid identity card. These are some examples of documents **not accepted** by the ID verification tool: diff --git a/pages/account/quickstart.mdx b/pages/account/quickstart.mdx index ac5111298f..5faf1fb892 100644 --- a/pages/account/quickstart.mdx +++ b/pages/account/quickstart.mdx @@ -12,6 +12,9 @@ dates: categories: - console --- +import CloseVsErase from '@macros/console/close-vs-erase.mdx' +import CreateAccount from '@macros/console/create-account.mdx' + Scaleway is a complete cloud ecosystem, offering a single way for you to create, deploy and scale your infrastructure in the cloud. Creating your Scaleway account gives you access to the [Scaleway console](/account/concepts/#console) and [Scaleway API](https://www.scaleway.com/en/developers/api/), and you can deploy our products and services with ease. @@ -21,7 +24,7 @@ Follow this guided tour to discover how to navigate the console. ## How to create an account - + ## How to create resources @@ -37,4 +40,4 @@ When you [close your account](/account/how-to/close-account/), you delete your O There is a delay of up to 10 days between the time your account is closed and the time the system deletes your resources. It is recommended to manually delete all your Organization's resources before closing your account. To reopen your account, [contact support](https://console.scaleway.com/support). - + diff --git a/pages/account/troubleshooting/cannot-log-into-my-account.mdx b/pages/account/troubleshooting/cannot-log-into-my-account.mdx index f51ab6947a..63ced1f6c5 100644 --- a/pages/account/troubleshooting/cannot-log-into-my-account.mdx +++ b/pages/account/troubleshooting/cannot-log-into-my-account.mdx @@ -12,13 +12,15 @@ dates: categories: - console --- +import image from './assets/scaleway-unrecognized-ip.webp' + If you encounter issues when connecting to your Scaleway account, there are several procedures you can follow to make sure you can log in securely. ## Unrecognized IP address error When logging into your Scaleway account, you may encounter the following message: - + This means you tried to log into your account from an unknown [IP address](/public-gateways/concepts/#ip-address). You may be logging in from a new device or location. As a security measure, we require you to use a [magic link](/account/concepts/#magic-link) to complete authentication. diff --git a/pages/account/troubleshooting/index.mdx b/pages/account/troubleshooting/index.mdx index 4e4e6ecd20..ca3623b744 100644 --- a/pages/account/troubleshooting/index.mdx +++ b/pages/account/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: AccountExperienceProductIcon ## Featured Pages - - - - - + ## VNC diff --git a/pages/apple-silicon/how-to/access-remote-desktop-mac-mini.mdx b/pages/apple-silicon/how-to/access-remote-desktop-mac-mini.mdx index ccd0f46cec..c8838a6de8 100644 --- a/pages/apple-silicon/how-to/access-remote-desktop-mac-mini.mdx +++ b/pages/apple-silicon/how-to/access-remote-desktop-mac-mini.mdx @@ -12,6 +12,11 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-apple-silicon-remote-desktop.webp' +import image2 from './assets/scaleway-m1-remote-desktop.webp' + This guide provides detailed instructions on how to access your [Mac mini](/apple-silicon/concepts/#mac-mini) using remote desktop clients. @@ -19,7 +24,7 @@ The macOS on your Mac mini uses the VNC protocol with additional Apple-specific Remote desktop allows you to visualize the graphical screen output of a remote computer and interact with it using your local keyboard and mouse. The VNC protocol is platform-independent, supporting Linux, Windows, and macOS, ensuring a seamless connection experience regardless of your operating system. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) @@ -41,7 +46,7 @@ The VNC protocol is platform-independent, supporting Linux, Windows, and macOS, 1. Click **Apple silicon** in the **Bare Metal** section of the side menu. A list of your Mac minis displays. 2. Click the Mac mini you want to connect to. The **Overview** page of your Mac mini displays. 3. Click **Open remote desktop** in the **Access remote desktop from macOS ①** section to launch Apple's built-in screen sharing client for a seamless remote desktop experience. - + Once your screen displays in your remote desktop client, log in to the graphical environment of macOS using the remote user and your password (available on the **Overview** page of your Mac mini). @@ -51,7 +56,7 @@ The VNC protocol is platform-independent, supporting Linux, Windows, and macOS, You are now logged in and can use your Mac mini as if you were physically present. - + @@ -148,4 +153,4 @@ Below is a matrix comparing features of the free versions of various remote desk Mac mini and macOS are trademarks of Apple Inc., registered in the U.S. and other countries and regions. iOS is a trademark or registered trademark of Cisco in the U.S. and other countries and is used by Apple under license. Scaleway is not affiliated with Apple Inc. - \ No newline at end of file + diff --git a/pages/apple-silicon/how-to/connect-to-mac-mini-ssh.mdx b/pages/apple-silicon/how-to/connect-to-mac-mini-ssh.mdx index ede1a1970d..c7807b4427 100644 --- a/pages/apple-silicon/how-to/connect-to-mac-mini-ssh.mdx +++ b/pages/apple-silicon/how-to/connect-to-mac-mini-ssh.mdx @@ -12,10 +12,15 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-m1-list.webp' +import image2 from './assets/scaleway-apple-silicon-ssh.webp' + You can connect directly to the terminal of your Mac mini using the SSH protocol and your [SSH key](/organizations-and-projects/concepts/#ssh-key). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) @@ -26,13 +31,13 @@ You can connect directly to the terminal of your Mac mini using the SSH protocol 1. Navigate to the [Scaleway console](https://console.scaleway.com) and log in with your credentials. 2. Click **Apple silicon** under the **Bare Metal** section in the side-menu. This displays a list of your Mac minis. - + 3. Click the name of the Mac mini you want to connect to. The **Overview** page for your selected Mac mini displays. You can find your SSH connection information under **SSH command**. - + 4. Open your terminal application and use the SSH command provided on the **Overview** page to connect. - The SSH command will be in the format: diff --git a/pages/apple-silicon/how-to/create-mac-mini.mdx b/pages/apple-silicon/how-to/create-mac-mini.mdx index b136ec0921..aaeb99c1fe 100644 --- a/pages/apple-silicon/how-to/create-mac-mini.mdx +++ b/pages/apple-silicon/how-to/create-mac-mini.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to create your first [Mac mini](/apple-silicon/concepts/#mac-mini) with the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/delete-mac-mini.mdx b/pages/apple-silicon/how-to/delete-mac-mini.mdx index a508b3c44c..e1e06b4ede 100644 --- a/pages/apple-silicon/how-to/delete-mac-mini.mdx +++ b/pages/apple-silicon/how-to/delete-mac-mini.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to delete your [Mac mini](/apple-silicon/concepts/#mac-mini). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/install-package-manager-mac-mini.mdx b/pages/apple-silicon/how-to/install-package-manager-mac-mini.mdx index e4b4ac5f72..dfa7528fe1 100644 --- a/pages/apple-silicon/how-to/install-package-manager-mac-mini.mdx +++ b/pages/apple-silicon/how-to/install-package-manager-mac-mini.mdx @@ -12,8 +12,10 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/manage-commitment-plan.mdx b/pages/apple-silicon/how-to/manage-commitment-plan.mdx index 9e1bcc4a20..5c6f94003d 100644 --- a/pages/apple-silicon/how-to/manage-commitment-plan.mdx +++ b/pages/apple-silicon/how-to/manage-commitment-plan.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + **Commitment plan for Apple silicon** is a flexible pricing option that allows you to choose between a fully flexible pay-as-you-go pricing or a long-term monthly commitment period for Apple silicon servers. By committing to a plan, you can enjoy better rates than pay-as-you-go pricing. @@ -24,7 +26,7 @@ It is important to note that the commitment applies only to the server. Options, Currently, it is not possible to switch from a monthly commitment to hourly billing. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A [Mac mini](/apple-silicon/how-to/create-mac-mini/) diff --git a/pages/apple-silicon/how-to/reboot-mac-mini.mdx b/pages/apple-silicon/how-to/reboot-mac-mini.mdx index 907bcde990..3bb077c8a0 100644 --- a/pages/apple-silicon/how-to/reboot-mac-mini.mdx +++ b/pages/apple-silicon/how-to/reboot-mac-mini.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to reboot your [Mac mini](/apple-silicon/concepts/#mac-mini) from the Scaleway console. This is useful if your Mac mini is unreachable, or you want to reboot it remotely. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/reinstall-mac-mini.mdx b/pages/apple-silicon/how-to/reinstall-mac-mini.mdx index 9a9734701b..ccb5d5989b 100644 --- a/pages/apple-silicon/how-to/reinstall-mac-mini.mdx +++ b/pages/apple-silicon/how-to/reinstall-mac-mini.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to reinstall your [Mac mini](/apple-silicon/concepts/#mac-mini) from the Scaleway console. This is useful if your Mac mini is not reachable, or you want to start from scratch on the machine. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/remove-public-ip.mdx b/pages/apple-silicon/how-to/remove-public-ip.mdx index 595739f7a9..63787a956d 100644 --- a/pages/apple-silicon/how-to/remove-public-ip.mdx +++ b/pages/apple-silicon/how-to/remove-public-ip.mdx @@ -12,13 +12,15 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + After enabling Virtual Private Cloud (VPC) on your Mac mini, you can enhance the security of your server by further restricting external access. This guide walks you through a series of steps to ensure that your Mac Mini is isolated from unauthorized access while maintaining necessary connectivity for management and maintenance. By following these instructions, you will learn how to create a secure environment that uses Private Networks and an SSH Bastion to protect your machine from being reachable on the public Internet, while maintaining outgoing connectivity from the Mac mini. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/setup-vm-with-utm.mdx b/pages/apple-silicon/how-to/setup-vm-with-utm.mdx index e577b69e40..8f3faaa0d2 100644 --- a/pages/apple-silicon/how-to/setup-vm-with-utm.mdx +++ b/pages/apple-silicon/how-to/setup-vm-with-utm.mdx @@ -12,11 +12,18 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-aps-utm-1.webp' +import image2 from './assets/scaleway-aps-utm-2.webp' +import image3 from './assets/scaleway-aps-utm-3.webp' +import image4 from './assets/scaleway-aps-utm-4.webp' + This guide explains the process to create a fully independent and functional virtual machine inside a Scaleway Mac using UTM, a powerful virtualization tool for macOS. UTM is a free and open-source software that leverages Apple's Hypervisor framework and QEMU to provide virtualization capabilities. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -42,15 +49,15 @@ UTM is a free and open-source software that leverages Apple's Hypervisor framewo * Configure your VM's properties: * Set your desired CPU cores (recommended at least 2 cores). * Allocate RAM (recommended at least 4 GB). - + * Configure the disk storage size (recommended at least 64 GB). - + * Click "Save" to create the VM. - + 4. Start and set up your macOS VM: * Once the VM is installed with your properties, click the "Run" button in UTM. * A GUI window will open displaying your VM. - + * Follow the macOS installation process: * Select language preferences. * Set up your Apple ID (optional). diff --git a/pages/apple-silicon/how-to/shutdown-mac-mini.mdx b/pages/apple-silicon/how-to/shutdown-mac-mini.mdx index 36200a8661..50159ad290 100644 --- a/pages/apple-silicon/how-to/shutdown-mac-mini.mdx +++ b/pages/apple-silicon/how-to/shutdown-mac-mini.mdx @@ -13,6 +13,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Due to operational constraints, a Scaleway Mac mini should not be fully shut down using conventional methods. Below are guidelines for managing your Mac mini's usage and shutdown procedures. @@ -21,7 +23,7 @@ Due to operational constraints, a Scaleway Mac mini should not be fully shut dow - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/test-mdm-workflows.mdx b/pages/apple-silicon/how-to/test-mdm-workflows.mdx index 693aabc57b..c74ca18449 100644 --- a/pages/apple-silicon/how-to/test-mdm-workflows.mdx +++ b/pages/apple-silicon/how-to/test-mdm-workflows.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's hosted Mac mini with UTM as a hypervisor provides a unique and powerful platform for testing and validating Mobile Device Management (MDM) solutions. @@ -20,7 +22,7 @@ It provides step-by-step instructions for enrolling a VM in an MDM server, testi By following this guide, you will be able to create a robust and isolated testing environment for your MDM solution, allowing you to validate its functionality, performance, and scalability. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/update-os-mac-mini.mdx b/pages/apple-silicon/how-to/update-os-mac-mini.mdx index 98768dae1c..fd214f60f0 100644 --- a/pages/apple-silicon/how-to/update-os-mac-mini.mdx +++ b/pages/apple-silicon/how-to/update-os-mac-mini.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This guide provides instructions on updating the operating system of a Scaleway Mac mini. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/upgrade-macos-to-beta.mdx b/pages/apple-silicon/how-to/upgrade-macos-to-beta.mdx index 628224492b..91848d6739 100644 --- a/pages/apple-silicon/how-to/upgrade-macos-to-beta.mdx +++ b/pages/apple-silicon/how-to/upgrade-macos-to-beta.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This guide explains the steps to upgrade the macOS of a Scaleway Mac mini to a beta version. - + - A Scaleway account logged into the [console](https://console.scaleway.com/) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/how-to/use-private-networks.mdx b/pages/apple-silicon/how-to/use-private-networks.mdx index 5aced3fff8..aeb52ba126 100644 --- a/pages/apple-silicon/how-to/use-private-networks.mdx +++ b/pages/apple-silicon/how-to/use-private-networks.mdx @@ -12,6 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-m1-network.webp' +import image2 from './assets/scaleway-m1-vlan.webp' +import image3 from './assets/scaleway-m1-vlan-details.webp' + Private Networks allow your Mac mini to communicate in an isolated and secure network with other Scaleway resources. This is an optional-billed feature for Mac mini. @@ -19,7 +25,7 @@ When the feature is activated, each Mac mini can be connected to one or several For full information about Scaleway Private Networks and VPC, see our [dedicated documentation](/vpc/) and [best practice guide](/vpc/reference-content/getting-most-private-networks/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -112,14 +118,14 @@ No configuration is required for your Mac mini's IP address on the Private Netwo 1. Make a note of your Mac mini's **VLAN ID**. You can view this in the Scaleway console, in the **Private Networks** tab of the Mac mini in question. 2. [Access the Mac mini's remote desktop](/apple-silicon/how-to/access-remote-desktop-mac-mini/). 3. Go to **System Settings** > **Network**, then click **...v** and select **Manage Virtual Interfaces** from the menu that displays. - + 4. Click **+** > **New VLAN** to add a new virtual interface. - + 5. Enter a **VLAN name** of your choice, the VLAN ID from step 1 in the **Tag** field, and **Ethernet** as the interface. Click **Done**. The VLAN interface is created. You can check its status in the **Network** tab, and see its full details by clicking on it. - + No configuration is required for your Mac mini's IP address on the Private Network, as this is automatically managed by Scaleway DHCP. diff --git a/pages/apple-silicon/index.mdx b/pages/apple-silicon/index.mdx index dacef03787..70edc856aa 100644 --- a/pages/apple-silicon/index.mdx +++ b/pages/apple-silicon/index.mdx @@ -54,22 +54,22 @@ meta: ## Tutorials - - - - \ No newline at end of file +/> diff --git a/pages/apple-silicon/quickstart.mdx b/pages/apple-silicon/quickstart.mdx index 5504e993a4..8c635f3be2 100644 --- a/pages/apple-silicon/quickstart.mdx +++ b/pages/apple-silicon/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Apple silicon as-a-Service uses Apple Mac mini hardware. These devices rely on the power of Apple's silicon technology, ensuring exceptional performance and groundbreaking energy efficiency. @@ -21,7 +23,7 @@ Apple silicon as-a-Service is tailored for developing, building, testing, and si Discover the Apple silicon interface on the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx b/pages/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx index 33ea2aa4fe..543832b547 100644 --- a/pages/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx +++ b/pages/apple-silicon/troubleshooting/cant-connect-using-ssh.mdx @@ -12,8 +12,10 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx b/pages/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx index 395c5c4cc8..873907fb46 100644 --- a/pages/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx +++ b/pages/apple-silicon/troubleshooting/cant-connect-using-vnc.mdx @@ -12,8 +12,10 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/apple-silicon/troubleshooting/index.mdx b/pages/apple-silicon/troubleshooting/index.mdx index d911c21e89..23e15569e9 100644 --- a/pages/apple-silicon/troubleshooting/index.mdx +++ b/pages/apple-silicon/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: AppleSiliconProductIcon ## Featured Pages - - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/audit-trail/reference-content/adt-supported-endpoints.mdx b/pages/audit-trail/reference-content/adt-supported-endpoints.mdx index e3174fea21..72286689d4 100644 --- a/pages/audit-trail/reference-content/adt-supported-endpoints.mdx +++ b/pages/audit-trail/reference-content/adt-supported-endpoints.mdx @@ -12,17 +12,22 @@ dates: categories: - identity-and-access-management --- +import AdtIamEndpoints from '@macros/audit-trail/iam-endpoints.mdx' +import AdtKeyManagerEndpoints from '@macros/audit-trail/key-manager-endpoints.mdx' +import AdtKubernetesEndpoints from '@macros/audit-trail/kubernetes-endpoints.mdx' +import AdtSecretManagerEndpoints from '@macros/audit-trail/secret-manager-endpoints.mdx' + This page provides information on the specific endpoints logged in [Audit Trail](/audit-trail/) for Scaleway products. Refer to the [dedicated documentation](/audit-trail/reference-content/resource-integration-with-adt/) for a list of Scaleway products integrated with Audit Trail. - + - + - + - \ No newline at end of file + \ No newline at end of file diff --git a/pages/audit-trail/troubleshooting/index.mdx b/pages/audit-trail/troubleshooting/index.mdx index 04bf5a5304..d427187b2e 100644 --- a/pages/audit-trail/troubleshooting/index.mdx +++ b/pages/audit-trail/troubleshooting/index.mdx @@ -20,13 +20,13 @@ productIcon: AuditTrailProductIcon ## Featured Pages - - + + Your Scaleway invoice contains the following sections: diff --git a/pages/billing/additional-content/understanding-savings-plans.mdx b/pages/billing/additional-content/understanding-savings-plans.mdx index a70d114041..6963c86078 100644 --- a/pages/billing/additional-content/understanding-savings-plans.mdx +++ b/pages/billing/additional-content/understanding-savings-plans.mdx @@ -12,6 +12,9 @@ dates: categories: - billing --- +import image from './assets/scaleway-savings-plan.webp' +import image2 from './assets/scaleway-invoice-taxes.webp' + Scaleway's savings plan is a commitment-based discount program that provides more cost-effective billing compared to the pay-as-you-go model. This plan merges the benefits of discounted rates with the adaptability of pay-as-you-go billing. @@ -32,7 +35,7 @@ When you purchase a savings plan, you: - If you use more resources than the committed amount, you will be charged the standard prices for the excess amount. - + ### Example @@ -105,7 +108,7 @@ We do not make refunds for savings plans that have already been invoiced. The total cost displayed for the savings plan does not include applicable taxes. Taxes are displayed on a dedicated section of the invoice, under the summary of your Projects' total consumption. - + Currently, we invoice all customers in euros (EUR). If your primary currency is different, our Payment Service Providers (PSPs) apply the prevailing exchange rate. diff --git a/pages/billing/api-cli/retrieve-monthly-consumption.mdx b/pages/billing/api-cli/retrieve-monthly-consumption.mdx index 5293df473d..8acd5fe2ae 100644 --- a/pages/billing/api-cli/retrieve-monthly-consumption.mdx +++ b/pages/billing/api-cli/retrieve-monthly-consumption.mdx @@ -12,10 +12,12 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + Follow the procedure below to download your monthly consumption using the Scaleway [Billing API](https://www.scaleway.com/en/developers/api/billing/#path-consumption-get-monthly-consumption) and `curl`. - + - A Scaleway account and logged into the [console](https://console.scaleway.com/organization) - Created an [API key](/iam/how-to/create-api-keys/) with sufficient [IAM permissions](/iam/reference-content/permission-sets/) to perform the actions described on this page diff --git a/pages/billing/how-to/add-billing-contact.mdx b/pages/billing/how-to/add-billing-contact.mdx index ae1d280974..afae058ec0 100644 --- a/pages/billing/how-to/add-billing-contact.mdx +++ b/pages/billing/how-to/add-billing-contact.mdx @@ -12,12 +12,14 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + You can set up notifications about your Organization's billing either for existing user of your Organization, or an external user who will only receive the information via email, but not be able to log in to your Organization. When you enable billing notifications for a user they will receive your Organization's monthly invoices, budget alerts and be informed if your payment method expires, for example. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/add-payment-method.mdx b/pages/billing/how-to/add-payment-method.mdx index 778b53a166..cc2dca03a1 100644 --- a/pages/billing/how-to/add-payment-method.mdx +++ b/pages/billing/how-to/add-payment-method.mdx @@ -12,10 +12,12 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + Before you can order Scaleway resources, you must add a payment method to your account. You can choose between two payment methods: **credit card** or **SEPA mandate**. Virtual and pre-paid credit cards are not accepted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/change-billing-information.mdx b/pages/billing/how-to/change-billing-information.mdx index 99f226d737..4387293081 100644 --- a/pages/billing/how-to/change-billing-information.mdx +++ b/pages/billing/how-to/change-billing-information.mdx @@ -12,8 +12,10 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/change-payment-method.mdx b/pages/billing/how-to/change-payment-method.mdx index 790feb85f2..315130ce4c 100644 --- a/pages/billing/how-to/change-payment-method.mdx +++ b/pages/billing/how-to/change-payment-method.mdx @@ -12,10 +12,12 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + If you have registered both a **credit card** and a **SEPA mandate**, you can choose the default payment method you wish to use for your Scaleway account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/download-an-invoice.mdx b/pages/billing/how-to/download-an-invoice.mdx index eb16fba0ac..c2b19e41eb 100644 --- a/pages/billing/how-to/download-an-invoice.mdx +++ b/pages/billing/how-to/download-an-invoice.mdx @@ -12,8 +12,10 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) that allow you to perform actions in the intended Organization diff --git a/pages/billing/how-to/purchase-savings-plan.mdx b/pages/billing/how-to/purchase-savings-plan.mdx index b1d4e69285..baa018fd25 100644 --- a/pages/billing/how-to/purchase-savings-plan.mdx +++ b/pages/billing/how-to/purchase-savings-plan.mdx @@ -12,12 +12,14 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + Savings plans provide a flexible pricing structure designed to optimize costs. By committing to consistent usage, you unlock substantial discounts compared to pay-as-you-go models, resulting in significant long-term savings. Savings plans are available for Compute resources. For more details about how Savings plans work, how they are billed and which resources are covered, refer to the [Understanding savings plans](/billing/additional-content/understanding-savings-plans/) documentation page. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/redeem-voucher-code.mdx b/pages/billing/how-to/redeem-voucher-code.mdx index 74ca95ae02..8bc944dc8a 100644 --- a/pages/billing/how-to/redeem-voucher-code.mdx +++ b/pages/billing/how-to/redeem-voucher-code.mdx @@ -12,12 +12,14 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + A Scaleway voucher provides you with a discount or credit to use on our services. You can receive it as part of a promotional campaign or from your account manager. To redeem a voucher, you need to [create a Scaleway account](/account/how-to/create-an-account/). Voucher codes are unique and valid only for a defined period. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) that allow you to perform actions in the intended Organization diff --git a/pages/billing/how-to/use-billing-alerts.mdx b/pages/billing/how-to/use-billing-alerts.mdx index d4351fbae3..4e7874f833 100644 --- a/pages/billing/how-to/use-billing-alerts.mdx +++ b/pages/billing/how-to/use-billing-alerts.mdx @@ -12,6 +12,8 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + Billing alerts allow you to oversee your expenses efficiently. This feature allows you to create alerts that notify you when predefined budget thresholds are met. Your alerts can be seamlessly delivered through SMS, email, or API webhooks. @@ -21,7 +23,7 @@ Your budget, denominated in euros, represents the limit for your expenses. Simul - If you have defined a budget of €1,000, you may configure an email notification to be sent once you have consumed 50% of this limit. In this case, once your consumption reaches €500, you will receive an email informing you that the limit threshold has been reached. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/how-to/use-the-cost-manager.mdx b/pages/billing/how-to/use-the-cost-manager.mdx index d28b70de6e..43a7f8493f 100644 --- a/pages/billing/how-to/use-the-cost-manager.mdx +++ b/pages/billing/how-to/use-the-cost-manager.mdx @@ -12,10 +12,15 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-billing-consumption-chart.webp' +import image2 from './assets/scaleway-billing-consumption-list.webp' + The Scaleway cost manager is a comprehensive tool to monitor and analyze cloud resource consumption and costs. It offers a clear and detailed view of consumption data, enabling you to accurately consolidate consumption for re-invoicing purposes. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -45,14 +50,14 @@ The Scaleway cost manager is a comprehensive tool to monitor and analyze cloud r The amount displayed in the chart is the total amount consumed over the period excluding tax, and **excluding** any discounts related to vouchers. - + 5. Scroll the page to see a detailed list of your resource consumption based on your filter selection. The amount displayed is the total amount consumed over the period excluding tax, and **including** any discounts related to vouchers. - + In the list you can see the product categories on the left. They follow the same order as the left menu of the Scaleway console. diff --git a/pages/billing/index.mdx b/pages/billing/index.mdx index f9a19efd45..9ca79a104b 100644 --- a/pages/billing/index.mdx +++ b/pages/billing/index.mdx @@ -42,22 +42,22 @@ meta: ## FAQ - - - - \ No newline at end of file +/> diff --git a/pages/billing/quickstart.mdx b/pages/billing/quickstart.mdx index 65d8bb3de8..b1ec655744 100644 --- a/pages/billing/quickstart.mdx +++ b/pages/billing/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - billing --- +import Requirements from '@macros/iam/requirements.mdx' + ## Console overview @@ -19,7 +21,7 @@ Follow this guided tour to discover how to use the Billing Space. Before you can order Scaleway resources, you must add your payment method to your account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/billing/troubleshooting/index.mdx b/pages/billing/troubleshooting/index.mdx index be31c66b19..e461369a08 100644 --- a/pages/billing/troubleshooting/index.mdx +++ b/pages/billing/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: BillingProductIcon ## Featured Pages - - - - - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Created [Block Storage volumes](/block-storage/how-to/create-a-volume/) diff --git a/pages/block-storage/api-cli/increasing-volume-size.mdx b/pages/block-storage/api-cli/increasing-volume-size.mdx index cd5f5c0d7c..c9f9cc6a1a 100644 --- a/pages/block-storage/api-cli/increasing-volume-size.mdx +++ b/pages/block-storage/api-cli/increasing-volume-size.mdx @@ -13,10 +13,12 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + The Block storage API allows you to interact with Block Storage volumes programmatically through API calls. Refer to the [Developers reference website](https://www.scaleway.com/en/developers/api/block/) for more information on how to use the Block Storage API. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/api-cli/managing-a-volume.mdx b/pages/block-storage/api-cli/managing-a-volume.mdx index 7f4269c8da..682e92a498 100644 --- a/pages/block-storage/api-cli/managing-a-volume.mdx +++ b/pages/block-storage/api-cli/managing-a-volume.mdx @@ -13,10 +13,12 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation only explains how to mount **additional block volumes to your Instance**, as the root volume of your Instance is already mounted at creation. The volume where your OS is running cannot be mounted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/api-cli/unmounting-a-volume.mdx b/pages/block-storage/api-cli/unmounting-a-volume.mdx index 0d31960939..314691280e 100644 --- a/pages/block-storage/api-cli/unmounting-a-volume.mdx +++ b/pages/block-storage/api-cli/unmounting-a-volume.mdx @@ -13,12 +13,14 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + ## Unmounting a Block Storage volume Unmounting a volume means detaching it from the operating system so it is no longer accessible. You can do this if you want to stop using it, prevent data corruption, or plan to [detach it](/block-storage/how-to/detach-a-volume/) from your Instance and attach it to another. This page shows you how to unmount a volume from the operating system using the `umount` command. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/concepts.mdx b/pages/block-storage/concepts.mdx index 7748d517d9..1d33d02bbd 100644 --- a/pages/block-storage/concepts.mdx +++ b/pages/block-storage/concepts.mdx @@ -13,18 +13,25 @@ categories: - block-storage - storage --- +import AvailabilityZone from '@macros/concepts/availability-zone.mdx' +import BlockSnapshot from '@macros/concepts/block-snapshot.mdx' +import BlockVolumes from '@macros/concepts/block-volumes.mdx' +import LocalVolumes from '@macros/concepts/local-volumes.mdx' +import Region from '@macros/concepts/region.mdx' +import StorageBootOnBlock from '@macros/storage/boot-on-block.mdx' + ## Availability Zone - + ## Block volumes - + ## Boot-on-block - + ## IOPS @@ -37,15 +44,15 @@ Scaleway Block Storage Low Latency offers two IOPS limits: ## Local volume - + ## Region - + ## Snapshot - + ## Storage Area Networks (SANs) diff --git a/pages/block-storage/how-to/attach-a-volume.mdx b/pages/block-storage/how-to/attach-a-volume.mdx index b6153e6b9a..7e95948256 100644 --- a/pages/block-storage/how-to/attach-a-volume.mdx +++ b/pages/block-storage/how-to/attach-a-volume.mdx @@ -13,9 +13,11 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can attach up to **15 volumes** at a time to a single Instance. You can attach a Block Storage volume to your Instance at any time, as long as they are both in the same [Availability Zone](/instances/concepts/#availability-zone). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/create-a-snapshot.mdx b/pages/block-storage/how-to/create-a-snapshot.mdx index 7c4617dfc9..3ef33c924e 100644 --- a/pages/block-storage/how-to/create-a-snapshot.mdx +++ b/pages/block-storage/how-to/create-a-snapshot.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/create-a-volume.mdx b/pages/block-storage/how-to/create-a-volume.mdx index b2de104547..5bac3435e1 100644 --- a/pages/block-storage/how-to/create-a-volume.mdx +++ b/pages/block-storage/how-to/create-a-volume.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/create-volume-from-snapshot.mdx b/pages/block-storage/how-to/create-volume-from-snapshot.mdx index a9f1a3d059..1fc8943dd8 100644 --- a/pages/block-storage/how-to/create-volume-from-snapshot.mdx +++ b/pages/block-storage/how-to/create-volume-from-snapshot.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/delete-a-snapshot.mdx b/pages/block-storage/how-to/delete-a-snapshot.mdx index 5bc24846c0..4c42bbec28 100644 --- a/pages/block-storage/how-to/delete-a-snapshot.mdx +++ b/pages/block-storage/how-to/delete-a-snapshot.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/delete-a-volume.mdx b/pages/block-storage/how-to/delete-a-volume.mdx index 35847aa5b2..f72814758b 100644 --- a/pages/block-storage/how-to/delete-a-volume.mdx +++ b/pages/block-storage/how-to/delete-a-volume.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/detach-a-volume.mdx b/pages/block-storage/how-to/detach-a-volume.mdx index 263052fb5c..67907ff263 100644 --- a/pages/block-storage/how-to/detach-a-volume.mdx +++ b/pages/block-storage/how-to/detach-a-volume.mdx @@ -13,12 +13,14 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can detach a Block Storage volume from your Instance at any time. Always [unmount the volume](/block-storage/api-cli/unmounting-a-volume/) from the operating system of your Instance before detaching it to avoid data loss. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/identify-api-managing-volumes.mdx b/pages/block-storage/how-to/identify-api-managing-volumes.mdx index 552c453dab..5d4b4f5263 100644 --- a/pages/block-storage/how-to/identify-api-managing-volumes.mdx +++ b/pages/block-storage/how-to/identify-api-managing-volumes.mdx @@ -12,19 +12,22 @@ dates: categories: - block-storage --- +import Requirements from '@macros/iam/requirements.mdx' +import BlockStorageMigration from '@macros/storage/block-storage-migration.mdx' + You can manage Block Storage resources using either the [Block Storage API](https://www.scaleway.com/en/developers/api/block/), or the [Instances API](https://www.scaleway.com/en/developers/api/instance/). This page shows you how to identify the API that manages your volumes and snapshots using the Scaleway console. Refer to our [dedicated documentation](/block-storage/api-cli/identifying-volume-snapshot-api/) to learn how to identify the API managing your volumes and snapshots using the API and CLI. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Created [Block Storage volumes](/block-storage/how-to/create-a-volume/) - Created [snapshots](/block-storage/how-to/create-a-snapshot/) - + ## How to identify your volume type diff --git a/pages/block-storage/how-to/increase-block-volume.mdx b/pages/block-storage/how-to/increase-block-volume.mdx index 41526c5693..6ee5257fc1 100644 --- a/pages/block-storage/how-to/increase-block-volume.mdx +++ b/pages/block-storage/how-to/increase-block-volume.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/how-to/migrate-volumes-snapshots-to-sbs.mdx b/pages/block-storage/how-to/migrate-volumes-snapshots-to-sbs.mdx index 42eaa86cd1..f1d75f5ed2 100644 --- a/pages/block-storage/how-to/migrate-volumes-snapshots-to-sbs.mdx +++ b/pages/block-storage/how-to/migrate-volumes-snapshots-to-sbs.mdx @@ -12,5 +12,7 @@ dates: categories: - compute --- +import HowToMigrateToSbs from '@macros/compute/how-to-migrate-to-sbs.mdx' - + + diff --git a/pages/block-storage/how-to/unmount-a-volume.mdx b/pages/block-storage/how-to/unmount-a-volume.mdx index 11baf12e6c..7b06bb6e4a 100644 --- a/pages/block-storage/how-to/unmount-a-volume.mdx +++ b/pages/block-storage/how-to/unmount-a-volume.mdx @@ -13,10 +13,12 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + Unmounting a volume means detaching it from the operating system so it is no longer accessible. You can do this if you want to stop using it, prevent data corruption, or plan to [detach it](/block-storage/how-to/detach-a-volume/) from your Instance and attach it to another. This page shows you how to unmount a volume from the operating system using the `umount` command. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/index.mdx b/pages/block-storage/index.mdx index fe074692b9..5a930ccacf 100644 --- a/pages/block-storage/index.mdx +++ b/pages/block-storage/index.mdx @@ -50,17 +50,17 @@ meta: ## API/CLI - - - + ## Console overview Discover the Block Storage interface on the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/block-storage/reference-content/advantages-migrating-to-sbs.mdx b/pages/block-storage/reference-content/advantages-migrating-to-sbs.mdx index 33b8659fa7..aaeec3c7fa 100644 --- a/pages/block-storage/reference-content/advantages-migrating-to-sbs.mdx +++ b/pages/block-storage/reference-content/advantages-migrating-to-sbs.mdx @@ -12,10 +12,12 @@ dates: categories: - storage --- +import BlockStorageNoMigrationForK8s from '@macros/storage/block-storage-no-migration-for-k8s.mdx' + This page explains why **Instance users** should migrate from the Instance API to the Block Storage API to create and manage block volumes and snapshots. - + ## Transitioning from the Instance API to the Block Storage API for volume and snapshot management diff --git a/pages/block-storage/troubleshooting/index.mdx b/pages/block-storage/troubleshooting/index.mdx index c8a8e18597..dc234d200e 100644 --- a/pages/block-storage/troubleshooting/index.mdx +++ b/pages/block-storage/troubleshooting/index.mdx @@ -18,19 +18,19 @@ productIcon: BlockStorageProductIcon /> ## Featured Pages - - - +import image from './assets/scaleway_logcenter_define_password.webp' + + + The logcenter allows you to visualize real-time error logs of your hosting. That way, you can quickly troubleshoot potential issues linked to your code. - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** plan @@ -28,7 +33,7 @@ The logcenter allows you to visualize real-time error logs of your hosting. That 2. Click **Manage** next to the hosting you want to configure. The webhosting overview page displays. 3. Click **Statistics and logs** in the side menu. The statistics and logs overview page displays. 4. Go to the **Logs** section and click **Define password**. If you want to reset your password, click **Reset password**. - + 5. Enter a password and its confirmation, then click **Edit account**. For a strong password, combine lowercase, uppercase, numbers, and special characters. diff --git a/pages/classic-hosting/how-to/access-statistics.mdx b/pages/classic-hosting/how-to/access-statistics.mdx index 4ae1b98586..2d5480af4d 100644 --- a/pages/classic-hosting/how-to/access-statistics.mdx +++ b/pages/classic-hosting/how-to/access-statistics.mdx @@ -12,12 +12,17 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_webhosting_statistics.webp' + + + With each of our Webhosting Classic offers, we provide the possibility to visualize the statistics of your website (number of visits, number of unique visitors, bandwidth used, etc.). - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** plan @@ -37,7 +42,7 @@ With each of our Webhosting Classic offers, we provide the possibility to visual 1. Open the following URL in your web browser: `https://stats.online.net/domain/example.com/` (replace `example.com` with your domain name) to access the statistics. 2. Enter the password set in the previous step and hit `Enter`. The statistics dashboard displays. - + The dashboard contains the following information: diff --git a/pages/classic-hosting/how-to/change-email-account-password.mdx b/pages/classic-hosting/how-to/change-email-account-password.mdx index c59552e70a..062783c509 100644 --- a/pages/classic-hosting/how-to/change-email-account-password.mdx +++ b/pages/classic-hosting/how-to/change-email-account-password.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** plan diff --git a/pages/classic-hosting/how-to/change-ftp-account-password.mdx b/pages/classic-hosting/how-to/change-ftp-account-password.mdx index ca829a0090..dfc7e03048 100644 --- a/pages/classic-hosting/how-to/change-ftp-account-password.mdx +++ b/pages/classic-hosting/how-to/change-ftp-account-password.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** plan diff --git a/pages/classic-hosting/how-to/change-password-mysql-database.mdx b/pages/classic-hosting/how-to/change-password-mysql-database.mdx index 3fb54bc897..a857d10cc9 100644 --- a/pages/classic-hosting/how-to/change-password-mysql-database.mdx +++ b/pages/classic-hosting/how-to/change-password-mysql-database.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** plan diff --git a/pages/classic-hosting/how-to/change-password-postgresql-database.mdx b/pages/classic-hosting/how-to/change-password-postgresql-database.mdx index 94826e7c6f..220fc969a2 100644 --- a/pages/classic-hosting/how-to/change-password-postgresql-database.mdx +++ b/pages/classic-hosting/how-to/change-password-postgresql-database.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** plan diff --git a/pages/classic-hosting/how-to/check-emails.mdx b/pages/classic-hosting/how-to/check-emails.mdx index becf4ad404..732f1aad50 100644 --- a/pages/classic-hosting/how-to/check-emails.mdx +++ b/pages/classic-hosting/how-to/check-emails.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** plan diff --git a/pages/classic-hosting/how-to/configure-backup-option.mdx b/pages/classic-hosting/how-to/configure-backup-option.mdx index 7d785e65b4..9bdf7e037a 100644 --- a/pages/classic-hosting/how-to/configure-backup-option.mdx +++ b/pages/classic-hosting/how-to/configure-backup-option.mdx @@ -12,8 +12,14 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_backups_filezilla.webp' +import image2 from './assets/scaleway_backups_emails.webp' + + + Because you can never be safe against human failure, a hardware fault, or piracy of your data we offer a secured storage space, accessible by FTP, containing the backups of your webhosting and your databases. @@ -26,7 +32,7 @@ The offer includes: * More information about this option and its pricing is available on our [website](https://www.scaleway.com/en/web-hosting/#sauvegarde). - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** plan @@ -47,14 +53,14 @@ The offer includes: ## How to configure your FTP/SQL backup - + - Set up the backup option for your webhosting 1. Click **Hosting** then click **Manage** next to your webhosting. 2. Click **Backup** to find the data required to configure your backup. A page displays your identifier and password to access your backup with an FTP client. 3. Launch [FileZilla](https://filezilla-project.org/) on your computer and enter your credentials to connect to the backup. - + * The backups are placed in the root directory and are named by the date of their creation. SQL backups can be found in the subdirectory `database_backup`. @@ -68,7 +74,7 @@ The offer includes: 1. Log into the [webmail](https://backup-mail.online.net/) using your email address and usual password. 2. You can access your current mailbox and your backups. - + 3. Click and drag the backup folders to your current mailbox to restore your old emails. diff --git a/pages/classic-hosting/how-to/configure-htaccess-file.mdx b/pages/classic-hosting/how-to/configure-htaccess-file.mdx index 455560180c..a23b82fed4 100644 --- a/pages/classic-hosting/how-to/configure-htaccess-file.mdx +++ b/pages/classic-hosting/how-to/configure-htaccess-file.mdx @@ -12,8 +12,10 @@ dates: categories: - webhosting --- +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + `.htaccess` is a simple text file containing commands for configuring the Apache web server. It allows you to customize the server dynamically and per folder. diff --git a/pages/classic-hosting/how-to/configure-outlook.mdx b/pages/classic-hosting/how-to/configure-outlook.mdx index a5f5788747..fe5f40ee22 100644 --- a/pages/classic-hosting/how-to/configure-outlook.mdx +++ b/pages/classic-hosting/how-to/configure-outlook.mdx @@ -12,12 +12,19 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway-outlook2013-mutu.webp' +import image2 from './assets/scaleway-outlook2013-ports.webp' +import image3 from './assets/scaleway-outlook2013-smtp.webp' + + + You can read and send your emails using the Microsoft Outlook client. - + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** @@ -40,10 +47,10 @@ You can [configure](https://support.microsoft.com/en-us/office/add-an-email-acco * TCP port: 587 or 465 * Connection type TLS - + 2. Click **More settings**, then select **Advanced** to configure the ports: - + 3. Click **Outgoing server** and tick the box **My outgoing server requires authentication**. Then click **OK** to validate. - + diff --git a/pages/classic-hosting/how-to/configure-php.mdx b/pages/classic-hosting/how-to/configure-php.mdx index 89dec9a5de..68f7a7b038 100644 --- a/pages/classic-hosting/how-to/configure-php.mdx +++ b/pages/classic-hosting/how-to/configure-php.mdx @@ -12,8 +12,12 @@ dates: categories: - webhosting --- +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_website_php.webp' + + + ## How to configure PHP at Scaleway @@ -276,7 +280,7 @@ The default version for `.php` is 7.3 for current webhosting accounts. For older 2. Click **Hosting**, then **Manage**, next to your webhosting. 3. Click **Manage** in the menu on the right. The **Website configuration** page displays. 4. Click the **Edit** action. - + 5. Select the PHP version of your choice. 6. Click **Submit** to update your PHP version. diff --git a/pages/classic-hosting/how-to/connect-via-ftp.mdx b/pages/classic-hosting/how-to/connect-via-ftp.mdx index 403409ce91..ab59a040bb 100644 --- a/pages/classic-hosting/how-to/connect-via-ftp.mdx +++ b/pages/classic-hosting/how-to/connect-via-ftp.mdx @@ -12,14 +12,20 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway-filezilla-newsite.webp' +import image2 from './assets/scaleway_ftp_sslcertificate_2022.webp' + + + **F**ile **T**ransfer **P**rotocol (FTP) is a standard method for transferring files between a client (e.g., your local computer) and a server (e.g., your Scaleway web hosting server) via the internet. This guide shows you how to configure the popular and free FTP client [FileZilla](https://filezilla-project.org/) to connect to your web hosting site using FTP. You will then be able to transfer files from your local computer to your Scaleway web hosting server. For additional help, refer to the [FileZilla Client Tutorial](https://wiki.filezilla-project.org/FileZilla_Client_Tutorial_(en)). In this example, we assume your domain name is `example.com` and your FTP account is `webmaster@example.com`. Ensure you have [created an FTP account](/classic-hosting/how-to/create-ftp-account/) before proceeding. - + - A Dedibox account logged into the [console](https://console.online.net) - A **Web Hosting Classic** plan and a domain name - An [FTP account created](/classic-hosting/how-to/create-ftp-account/) @@ -39,7 +45,7 @@ In this example, we assume your domain name is `example.com` and your FTP accoun 1. Open FileZilla on your local machine. 2. Click on **File** in the top menu, and select **Site Manager**. 3. Enter the following information in the form that displays. Remember to replace the **User** and **Password** values with [those of your FTP account](/classic-hosting/how-to/create-ftp-account/). - + - **Protocol**: FTP - File Transfer Protocol - **Host**: `ftp.online.net` @@ -53,7 +59,7 @@ In this example, we assume your domain name is `example.com` and your FTP accoun The form may display slightly differently depending on your operating system, but the fields and their values should remain the same. 4. Click **Connect**. If a confirmation window appears, check and validate the certificate. - + You are now connected via FTP to your web hosting site. Remember that all files for your website must be stored in the `www` folder. diff --git a/pages/classic-hosting/how-to/create-alias.mdx b/pages/classic-hosting/how-to/create-alias.mdx index 796e80b9b7..9805c81cd2 100644 --- a/pages/classic-hosting/how-to/create-alias.mdx +++ b/pages/classic-hosting/how-to/create-alias.mdx @@ -12,12 +12,15 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + On our web hosting offers, you can link an additional domain name as an alias to your website. For example, you have the domain names `mydomainname.fr` and `mydomainname.com`, and want the same website to be visible for both domains. - + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/create-email-account.mdx b/pages/classic-hosting/how-to/create-email-account.mdx index aae5bcc6fa..00d9ee1a23 100644 --- a/pages/classic-hosting/how-to/create-email-account.mdx +++ b/pages/classic-hosting/how-to/create-email-account.mdx @@ -12,16 +12,21 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_webhostingc_manage.webp' - + + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** 1. Click **Hosting**, then click **Manage**. - + The **Configure hosting** page displays. 2. Scroll to **E-mail accounts** and click **Manage**. diff --git a/pages/classic-hosting/how-to/create-email-redirection.mdx b/pages/classic-hosting/how-to/create-email-redirection.mdx index 970833c1c3..7ee7c90911 100644 --- a/pages/classic-hosting/how-to/create-email-redirection.mdx +++ b/pages/classic-hosting/how-to/create-email-redirection.mdx @@ -12,14 +12,19 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_add_email_redirection.webp' + + + A redirection is an alternative email address for one or multiple email accounts of the same domain. For example, you can create the alias [contact@example.com](mailto:contact@example.com), which will redirect the email to the personal email account [firstname.lastname@example.com](mailto:firstname.lastname@example.com). This allows you to have multiple email addresses without needing to have multiple email accounts. It is also possible to deliver the email to multiple recipients. This means, for our example, we can get the email sent to “contact” delivered to the email accounts “firstname.lastname” and also to “firstname2.lastname2”. - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** @@ -28,7 +33,7 @@ This allows you to have multiple email addresses without needing to have multipl 2. Scroll down to the **E-mail accounts** section in the side menu, then click **E-mail redirections**. 3. Click **Add e-mail redirection**. - + 4. Enter the required information for the alias (the name of the redirection and the recipient) to create the redirection. 5. Click **Add account** to confirm. diff --git a/pages/classic-hosting/how-to/create-email-transfer.mdx b/pages/classic-hosting/how-to/create-email-transfer.mdx index 492848050d..878b1dbf34 100644 --- a/pages/classic-hosting/how-to/create-email-transfer.mdx +++ b/pages/classic-hosting/how-to/create-email-transfer.mdx @@ -12,12 +12,15 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + Email transfers allow you to forward the incoming mail of an existing account to another address of your choice. - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/create-ftp-account.mdx b/pages/classic-hosting/how-to/create-ftp-account.mdx index d8543ae1dc..f13b15fab3 100644 --- a/pages/classic-hosting/how-to/create-ftp-account.mdx +++ b/pages/classic-hosting/how-to/create-ftp-account.mdx @@ -12,12 +12,15 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + **F**ile **T**ransfer **P**rotocol is a standard way to transfer files between a client (such as your local computer) and a server (such as your Scaleway webhosting server) via the internet. In order to [use FTP](/classic-hosting/how-to/connect-via-ftp/), you must first create an account. - + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/create-mysql-database.mdx b/pages/classic-hosting/how-to/create-mysql-database.mdx index 8fc9dc3ffe..e4b7672778 100644 --- a/pages/classic-hosting/how-to/create-mysql-database.mdx +++ b/pages/classic-hosting/how-to/create-mysql-database.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/create-postgresql-database.mdx b/pages/classic-hosting/how-to/create-postgresql-database.mdx index 21c6837cb1..4790026d19 100644 --- a/pages/classic-hosting/how-to/create-postgresql-database.mdx +++ b/pages/classic-hosting/how-to/create-postgresql-database.mdx @@ -12,8 +12,11 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + PostgreSQL is an object-relational database management system that uses the SQL language. It is open source and well known for its stability, reliability and strong community. @@ -33,7 +36,7 @@ However, it has the following limitations: * Replication is harder to implement, * Generally less well-supported than MySQL in current projects (CMS, for example). - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/create-subdomain.mdx b/pages/classic-hosting/how-to/create-subdomain.mdx index 463288f89e..7c64d94fa0 100644 --- a/pages/classic-hosting/how-to/create-subdomain.mdx +++ b/pages/classic-hosting/how-to/create-subdomain.mdx @@ -12,12 +12,20 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_subdomain_ftp.webp' +import image2 from './assets/scaleway_subdomain_01.webp' +import image3 from './assets/scaleway_subdomain_02.webp' +import image4 from './assets/scaleway_subdomain_03.webp' + + + Subdomains are an additional part to extend your main domain name. Mostly, they are created to organize and navigate to different sections of your website. For example, you can host your main website at `www.example.com` and your blog at `blog.example.com`. - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** @@ -33,7 +41,7 @@ Subdomains are an additional part to extend your main domain name. Mostly, they ## How to upload content to your subdomain 1. Connect to your webhosting using your [FTP account](/classic-hosting/concepts/#ftp-account). A listing of your remote files and folders displays in the right part of the FTP client: - + 2. Double-click the folder with the same name as your subdomain to access it. 3. Upload your files into this directory. @@ -45,11 +53,11 @@ Subdomains are an additional part to extend your main domain name. Mostly, they It is also possible to create subdomains directly using your FTP client, without needing to create them via the Dedibox console. 1. Log into your webhosting using an FTP client. Your remote files are listed in the right part of the FTP client. - + 2. Create a new folder in the document root of your hosting, named after your subdomain: - + 3. Enter the newly created directory and upload your files into it: - + You now can access the files located in this directory as a subdomain of your webhosting. diff --git a/pages/classic-hosting/how-to/delete-email-account.mdx b/pages/classic-hosting/how-to/delete-email-account.mdx index a448321880..706ce2f9b0 100644 --- a/pages/classic-hosting/how-to/delete-email-account.mdx +++ b/pages/classic-hosting/how-to/delete-email-account.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-email-redirection.mdx b/pages/classic-hosting/how-to/delete-email-redirection.mdx index 0995767811..95b6fdfdd2 100644 --- a/pages/classic-hosting/how-to/delete-email-redirection.mdx +++ b/pages/classic-hosting/how-to/delete-email-redirection.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-email-transfer.mdx b/pages/classic-hosting/how-to/delete-email-transfer.mdx index fbfe176529..364f2758d4 100644 --- a/pages/classic-hosting/how-to/delete-email-transfer.mdx +++ b/pages/classic-hosting/how-to/delete-email-transfer.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-ftp-account.mdx b/pages/classic-hosting/how-to/delete-ftp-account.mdx index 5188b4347a..8a471f0bcc 100644 --- a/pages/classic-hosting/how-to/delete-ftp-account.mdx +++ b/pages/classic-hosting/how-to/delete-ftp-account.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-mysql-database.mdx b/pages/classic-hosting/how-to/delete-mysql-database.mdx index e9dfaadf62..a3c0449b65 100644 --- a/pages/classic-hosting/how-to/delete-mysql-database.mdx +++ b/pages/classic-hosting/how-to/delete-mysql-database.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-postgresql-database.mdx b/pages/classic-hosting/how-to/delete-postgresql-database.mdx index 7dcf5ac2d1..f0a2c64758 100644 --- a/pages/classic-hosting/how-to/delete-postgresql-database.mdx +++ b/pages/classic-hosting/how-to/delete-postgresql-database.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/delete-subdomain.mdx b/pages/classic-hosting/how-to/delete-subdomain.mdx index bce7511aa1..a012d31353 100644 --- a/pages/classic-hosting/how-to/delete-subdomain.mdx +++ b/pages/classic-hosting/how-to/delete-subdomain.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/enable-https.mdx b/pages/classic-hosting/how-to/enable-https.mdx index 2ce809ca83..49f1a11134 100644 --- a/pages/classic-hosting/how-to/enable-https.mdx +++ b/pages/classic-hosting/how-to/enable-https.mdx @@ -12,10 +12,16 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_insecure_connection.webp' +import image2 from './assets/scaleway_connection_failed.webp' - + + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** @@ -70,7 +76,7 @@ In some cases, it could not display it (Chrome did that in some cases). ### How to fix the "insecure connection" issue - + This may happen for example if the subdomain does not exist in the certificate. @@ -78,7 +84,7 @@ In this case, you need to add the subdomain in the console, or if it exists alre ### How to fix the "connection error" issue - + This error message means that there is no certificate for this domain. You need to verify the DNS records and force the regeneration by creating a subdomain from the Dedibox console. diff --git a/pages/classic-hosting/how-to/encrypt-emails-with-pgp-using-webmail.mdx b/pages/classic-hosting/how-to/encrypt-emails-with-pgp-using-webmail.mdx index c97d8748b9..d31d52c72c 100644 --- a/pages/classic-hosting/how-to/encrypt-emails-with-pgp-using-webmail.mdx +++ b/pages/classic-hosting/how-to/encrypt-emails-with-pgp-using-webmail.mdx @@ -12,8 +12,16 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_generate_import_key.webp' +import image2 from './assets/scaleway_once_generated.webp' +import image3 from './assets/scaleway_key_password.webp' +import image4 from './assets/scaleway_send_email.webp' + + + The [webmail](https://webmail.online.net/) used at Scaleway to read your emails, offers options to encrypt your mails with PGP, helping to ensure: @@ -26,7 +34,7 @@ The [webmail](https://webmail.online.net/) used at Scaleway to read your emails, The [Scaleway webmail interface](https://webmail.online.net) currently offers one way of encrypting your emails: `Mailvelope`. - + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** @@ -42,9 +50,9 @@ The [Scaleway webmail interface](https://webmail.online.net) currently offers on 1. Install the `Mailvelope` extension depending on the browser you use. 2. Once the extension is installed, click **Options**. 3. **Generate** or **import** an already existing key. You can keep the advanced parameters in their default values. - + 4. Once generated or imported, the key appears in the list of available keys in the extension. - + 5. Enter your Scaleway webmail interface and click the logo of the extension, then **Add**. ## How to write a PGP signed or encrypted email @@ -53,7 +61,7 @@ The [Scaleway webmail interface](https://webmail.online.net) currently offers on 2. Click the **icon of the extension** to write an email with PGP. A pop-up displays. 3. Write your email and click **sign** or **encrypt** the email. 4. Enter your key password: - + 5. Click **OK**. ## How to encrypt and sign an email @@ -67,7 +75,7 @@ The [Scaleway webmail interface](https://webmail.online.net) currently offers on ## How to send an email 1. Once you have been redirected after encrypting and/or signing, your email will appear in its final form in the window of the extension displaying: - + 2. Click **Transfer** to transfer your email into your webmail's interface. 3. Once transferred, you can send the email from your interface. diff --git a/pages/classic-hosting/how-to/manage-email-filter.mdx b/pages/classic-hosting/how-to/manage-email-filter.mdx index 2a7f3eb875..b689c051ea 100644 --- a/pages/classic-hosting/how-to/manage-email-filter.mdx +++ b/pages/classic-hosting/how-to/manage-email-filter.mdx @@ -12,12 +12,17 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_auto_reply1.webp' + + + Email filters allow you to sort your emails based on the sender, subject, and more. If an email meets one or more criteria, you can define different actions, such as deleting or moving it into a folder. Email filters only work on email accounts. - + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** @@ -62,5 +67,5 @@ Email filters allow you to sort your emails based on the sender, subject, and mo 4. Select **Reply with message** in the **execute the following actions** input field. 5. Write your message in **Message body**. 6. Type in **[Auto reply]** in **Message subject**. - + 7. Click **Save**. diff --git a/pages/classic-hosting/how-to/manage-mysql-database-phpmyadmin.mdx b/pages/classic-hosting/how-to/manage-mysql-database-phpmyadmin.mdx index 0edd83ca65..7e87d71cce 100644 --- a/pages/classic-hosting/how-to/manage-mysql-database-phpmyadmin.mdx +++ b/pages/classic-hosting/how-to/manage-mysql-database-phpmyadmin.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/manage-postgresql-database-adminer.mdx b/pages/classic-hosting/how-to/manage-postgresql-database-adminer.mdx index 99038b068a..89eb914a08 100644 --- a/pages/classic-hosting/how-to/manage-postgresql-database-adminer.mdx +++ b/pages/classic-hosting/how-to/manage-postgresql-database-adminer.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the Online [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/retrieve-headers-of-email.mdx b/pages/classic-hosting/how-to/retrieve-headers-of-email.mdx index 3197f2db43..b7e108f4d7 100644 --- a/pages/classic-hosting/how-to/retrieve-headers-of-email.mdx +++ b/pages/classic-hosting/how-to/retrieve-headers-of-email.mdx @@ -12,8 +12,10 @@ dates: categories: - webhosting --- +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - + + The header of an email contains essential information about the path and origins of the email before it arrives in your mailbox. It is comparable to the postmark and routing information on a physical envelope sent through the mail. diff --git a/pages/classic-hosting/how-to/solve-email-account-connection-problems.mdx b/pages/classic-hosting/how-to/solve-email-account-connection-problems.mdx index 8e004fc8fb..90e0a09c77 100644 --- a/pages/classic-hosting/how-to/solve-email-account-connection-problems.mdx +++ b/pages/classic-hosting/how-to/solve-email-account-connection-problems.mdx @@ -12,10 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - - + + + - A Dedibox account logged into the [console](https://console.online.net) - Created a **Webhosting Classic** diff --git a/pages/classic-hosting/how-to/terminate-online-classic-hosting.mdx b/pages/classic-hosting/how-to/terminate-online-classic-hosting.mdx index 70ca1d3dde..a0a23753c1 100644 --- a/pages/classic-hosting/how-to/terminate-online-classic-hosting.mdx +++ b/pages/classic-hosting/how-to/terminate-online-classic-hosting.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-console --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to terminate an Online (Dedibox) Web Hosting plan. - + - A Dedibox account logged into the [console](https://console.online.net) - An active Online Web Hosting plan diff --git a/pages/classic-hosting/quickstart.mdx b/pages/classic-hosting/quickstart.mdx index 2e20eb1fce..9a4cbc6292 100644 --- a/pages/classic-hosting/quickstart.mdx +++ b/pages/classic-hosting/quickstart.mdx @@ -12,8 +12,13 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' +import WebhostingOnline from '@macros/webhosting/webhosting-online.mdx' - +import image from './assets/scaleway_create_email.webp' + + + Webhosting Classic is Scaleway's historical web hosting service. It allows you to host your personal website and create personalized email addresses using your domain name. @@ -22,7 +27,7 @@ Webhosting Classic is Scaleway's historical web hosting service. It allows you t * Existing customers of Webhosting Classic can continue to use and configure their hosting as usual. - + - A Dedibox account logged into the Online [console](https://console.online.net) - A **Webhosting Classic** and a domain name @@ -33,7 +38,7 @@ Webhosting Classic is Scaleway's historical web hosting service. It allows you t 2. Click **Manage** next to the hosting you want to configure. The webhosting overview page displays. 3. Click **Manage** in the **E-mail accounts** section of the side menu. The email accounts overview page displays. 4. Click **Add account**. A pop-up displays. - + 5. Enter the login (the part before the `@`) for your email address, your password and confirm your password. Then click **Add account**. - The status of the account changes to **Waiting for update**. During this time, no other change to the email account is possible. diff --git a/pages/cockpit/api-cli/querying-logs-with-logcli.mdx b/pages/cockpit/api-cli/querying-logs-with-logcli.mdx index 7226ee4b4e..114eec7647 100644 --- a/pages/cockpit/api-cli/querying-logs-with-logcli.mdx +++ b/pages/cockpit/api-cli/querying-logs-with-logcli.mdx @@ -12,13 +12,17 @@ dates: categories: - observability --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-data-source-url.webp' + This documentation page shows you how to retrieve your Scaleway and custom logs stored in Cockpit programmatically, using [LogCLI](https://grafana.com/docs/loki/latest/query/logcli/). Retrieving your logs programmatically can be useful in environments where automation, scalability, and integration with other systems are crucial. It enables advanced analytics, greater efficiency, and deeper insights than manual log retrieval through a user interface such as Grafana. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -38,7 +42,7 @@ Open a terminal and run the following command to export your environment variabl You can retrieve your data source URL in the [Data sources tab](https://console.scaleway.com/cockpit/dataSource) under the **API URL** section. - + ## Retrieving logs diff --git a/pages/cockpit/concepts.mdx b/pages/cockpit/concepts.mdx index ffd5b43ad5..a5515ec1bf 100644 --- a/pages/cockpit/concepts.mdx +++ b/pages/cockpit/concepts.mdx @@ -11,6 +11,8 @@ dates: categories: - observability --- +import image from './assets/scaleway-traces-concept.webp' + ## Agent @@ -185,6 +187,6 @@ Traces are an effective way to identify performance issues and bottlenecks in yo You can push traces with the Tempo-compatible agent supported by Scaleway: [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/). - + Scaleway only supports the [OpenTelemetry](https://opentelemetry.io/docs/what-is-opentelemetry/) agent for pushing traces. diff --git a/pages/cockpit/faq.mdx b/pages/cockpit/faq.mdx index 8ec847a17d..a42dc0f7a9 100644 --- a/pages/cockpit/faq.mdx +++ b/pages/cockpit/faq.mdx @@ -9,8 +9,10 @@ dates: category: observability productIcon: CockpitProductIcon --- +import CockpitPlanDeprecation from '@macros/cockpit/plan-deprecation.mdx' - + + ## What is Cockpit? diff --git a/pages/cockpit/how-to/access-grafana-and-managed-dashboards.mdx b/pages/cockpit/how-to/access-grafana-and-managed-dashboards.mdx index 085aa7708f..b00d49b947 100644 --- a/pages/cockpit/how-to/access-grafana-and-managed-dashboards.mdx +++ b/pages/cockpit/how-to/access-grafana-and-managed-dashboards.mdx @@ -12,12 +12,14 @@ dates: validation: 2024-12-26 posted: 2022-10-31 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway provides you with preconfigured dashboards you can access in Grafana, for [Scaleway resources integrated with Cockpit](/cockpit/reference-content/cockpit-limitations/#product-integration-into-cockpit). This page shows you how to access [preconfigured dashboards](/cockpit/concepts/#preconfigured-dashboards). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/activate-managed-alerts.mdx b/pages/cockpit/how-to/activate-managed-alerts.mdx index 3fd645a210..01a1aa4237 100644 --- a/pages/cockpit/how-to/activate-managed-alerts.mdx +++ b/pages/cockpit/how-to/activate-managed-alerts.mdx @@ -11,10 +11,12 @@ dates: validation: 2025-04-08 posted: 2024-04-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to activate [preconfigured alerts](/cockpit/concepts/#preconfigured-alerts) for your Cockpit resources using the [Scaleway console](https://console.scaleway.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Enabled](/cockpit/how-to/enable-alert-manager/) the alert manager diff --git a/pages/cockpit/how-to/activate-push-traces.mdx b/pages/cockpit/how-to/activate-push-traces.mdx index 90c1e4ea30..76ca0e3d9b 100644 --- a/pages/cockpit/how-to/activate-push-traces.mdx +++ b/pages/cockpit/how-to/activate-push-traces.mdx @@ -11,10 +11,12 @@ dates: validation: 2024-12-26 posted: 2023-10-31 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create [traces](/cockpit/concepts/#traces) from the Scaleway console, retrieve traces push path, configure the OpenTelemetry HTTP agent, and push traces. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Project diff --git a/pages/cockpit/how-to/add-contact-points.mdx b/pages/cockpit/how-to/add-contact-points.mdx index 6fa3c89f00..d154c3d7e1 100644 --- a/pages/cockpit/how-to/add-contact-points.mdx +++ b/pages/cockpit/how-to/add-contact-points.mdx @@ -11,10 +11,12 @@ dates: validation: 2024-12-26 posted: 2024-04-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to associate [contact points](/cockpit/concepts/#contact-points) with the default [receiver](/cockpit/concepts/#receivers) using the [Scaleway console](https://console.scaleway.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/change-data-retention.mdx b/pages/cockpit/how-to/change-data-retention.mdx index 190ee3d4cc..c44362cb9f 100644 --- a/pages/cockpit/how-to/change-data-retention.mdx +++ b/pages/cockpit/how-to/change-data-retention.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-02 posted: 2024-11-25 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to change the [retention](/cockpit/concepts/#retention) period for your data sources. Refer to the [Cockpit FAQ](/cockpit/faq/) for detailed information on pricing. @@ -28,7 +30,7 @@ This page shows you how to change the [retention](/cockpit/concepts/#retention) Ingestion of custom data remains billable at [the current pricing](/cockpit/faq/#how-am-i-billed-for-using-cockpit-with-custom-data). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx b/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx index f859d22f84..c51cfe50e7 100644 --- a/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx +++ b/pages/cockpit/how-to/configure-alerts-for-scw-resources.mdx @@ -11,13 +11,27 @@ dates: validation: 2025-05-12 posted: 2023-11-06 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-switch-to-managed-alerts-button.webp' +import image2 from './assets/scaleway-metrics-browser.webp' +import image3 from './assets/scaleway-metrics-displayed.webp' +import image4 from './assets/scaleway-metric-selection.webp' +import image5 from './assets/scaleway-metrics-browser.webp' +import image6 from './assets/scaleway-metrics-displayed.webp' +import image7 from './assets/scaleway-metrics-browser.webp' +import image8 from './assets/scaleway-metrics-displayed.webp' +import image9 from './assets/scaleway-metrics-browser.webp' +import image10 from './assets/scaleway-metrics-displayed.webp' +import image11 from './assets/scaleway-alerts-firing.webp' + Cockpit does not support Grafana-managed alerting. It integrates with Grafana to visualize metrics, but alerts are managed through the Scaleway alert manager. You should use Grafana only to define alert rules, not to evaluate or receive alert notifications. Once the conditions of your alert rule are met, the Scaleway alert manager evaluates the rule and sends a notification to the contact points you have configured in the Scaleway console or in Grafana. This page shows you how to create alert rules in Grafana for monitoring Scaleway resources integrated with Cockpit, such as Instances, Object Storage, and Kubernetes. These alerts rely on Scaleway-provided metrics, which are preconfigured and available in the **Metrics browser** drop-down when using the **Scaleway Metrics data source** in the Grafana interface. This page explains how to use the `Scaleway Metrics` data source, interpret metrics, set alert conditions, and activate alerts. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -34,7 +48,7 @@ Data source managed alert rules allow you to configure alerts managed by the dat 2. Click the **Toggle menu** then click **Alerting**. 3. Click **Alert rules** and **+ New alert rule**. 4. In the **Define query and alert condition** section, scroll to the **Grafana-managed alert rule** information banner and click **Switch to data source-managed alert rule**. This step is **mandatory** because Cockpit does not support Grafana’s built-in alerting system, but only alerts configured and evaluated by the data source itself. You are redirected to the alert creation process. - + ## Define your metric and alert conditions @@ -47,15 +61,15 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec 1. Type a name for your alert. For example, `alert-for-high-cpu-usage`. 2. Select the **Scaleway Metrics** data source. 3. Click the **Metrics browser** drop-down. - - + + 4. Select the metric you want to configure an alert for. For example, `instance_server_cpu_seconds_total`. The `instance_server_cpu_seconds_total` metric records how many seconds of CPU time your Instance has used in total. It is helpful to detect unexpected CPU usage spikes. 5. Select the appropriate labels to filter your metric and target specific resources. 6. Choose values for your selected labels. The **Resulting selector** field displays your final query selector. - + 7. Click **Use query** to validate your metric selection. 8. In the query field next to the **Metrics browser** button, paste the following query. Make sure that the values for the labels you have selected (for example, `resource_id` and `resource_name`) correspond to those of the target resource. ```bash @@ -77,8 +91,8 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec 1. Type a name for your alert. 2. Select the **Scaleway Metrics** data source. 3. Click the **Metrics browser** drop-down. - - + + 4. Select the metric you want to configure an alert for. For example, `object_storage_bucket_objects_total`. The `object_storage_bucket_objects_total` metric indicates the total number of objects stored in a given Object Storage bucket. It is useful to monitor and control object growth in your bucket and avoid hitting thresholds. @@ -106,8 +120,8 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec 1. Type a name for your alert. 2. Select the **Scaleway Metrics** data source. 3. Click the **Metrics browser** drop-down. - - + + 4. Select the metric you want to configure an alert for. For example, `kubernetes_cluster_k8s_shoot_nodes_pods_usage_total`. The `kubernetes_cluster_k8s_shoot_nodes_pods_usage_total` metric represents the total number of pods currently running across all nodes in your Kubernetes cluster. It is helpful to monitor current pod consumption per node pool or cluster, and help track resource saturation or unexpected workload spikes. @@ -135,8 +149,8 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec 1. Type a name for your alert. 2. Select the **Scaleway Metrics** data source. 3. Click the **Metrics browser** drop-down. - - + + 4. Select the metric you want to configure an alert for. For example, `observability_cockpit_loki_chunk_store_stored_chunks_total:increase5m`. The `observability_cockpit_loki_chunk_store_stored_chunks_total:increase5m` metric represents the number of chunks (log storage blocks) that have been written over the last 5 minutes for a specific resource. It is useful to monitor log ingestion activity and detect issues such as a crash of the logging agent, or your application not producing logs. @@ -162,7 +176,7 @@ Switch between the tabs below to create alerts for a Scaleway Instance, an Objec You can view your firing alerts in the **Alert rules** section of your Grafana (**Home** > **Alerting** > **Alert rules**). - + You can configure up to a **maximum of 10 alerts** for the `Scaleway Metrics` data source. diff --git a/pages/cockpit/how-to/create-external-data-sources.mdx b/pages/cockpit/how-to/create-external-data-sources.mdx index aa41e1fc20..69ca032df6 100644 --- a/pages/cockpit/how-to/create-external-data-sources.mdx +++ b/pages/cockpit/how-to/create-external-data-sources.mdx @@ -11,10 +11,12 @@ dates: validation: 2025-04-04 posted: 2024-04-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create a **custom** [data source](/cockpit/concepts/#data-sources) and its [data type](/cockpit/concepts/#data-types), from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/create-token.mdx b/pages/cockpit/how-to/create-token.mdx index 70b88b5b90..6befcf2545 100644 --- a/pages/cockpit/how-to/create-token.mdx +++ b/pages/cockpit/how-to/create-token.mdx @@ -12,10 +12,12 @@ dates: validation: 2024-12-26 posted: 2022-10-31 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create [tokens](/cockpit/concepts/#cockpit-tokens), to grant other cloud providers’ services and platforms access to your [Cockpit](/cockpit/concepts/#cockpit). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/delete-external-data-sources.mdx b/pages/cockpit/how-to/delete-external-data-sources.mdx index f940b9452a..d9dd77cd46 100644 --- a/pages/cockpit/how-to/delete-external-data-sources.mdx +++ b/pages/cockpit/how-to/delete-external-data-sources.mdx @@ -11,10 +11,12 @@ dates: validation: 2025-03-26 posted: 2024-04-13 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a custom [data source](/cockpit/concepts/#data-sources) from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/enable-alert-manager.mdx b/pages/cockpit/how-to/enable-alert-manager.mdx index 773343c67f..d0c753ed44 100644 --- a/pages/cockpit/how-to/enable-alert-manager.mdx +++ b/pages/cockpit/how-to/enable-alert-manager.mdx @@ -11,10 +11,12 @@ dates: validation: 2025-04-08 posted: 2024-04-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to enable Scaleway's regionalized alert manager to configure preconfigured alerts for your Scaleway resources. - + - A Scaleway account logged into the [Scaleway console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/federate-scaleway-metrics.mdx b/pages/cockpit/how-to/federate-scaleway-metrics.mdx index ca83dbf979..537b8b6bf2 100644 --- a/pages/cockpit/how-to/federate-scaleway-metrics.mdx +++ b/pages/cockpit/how-to/federate-scaleway-metrics.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-07-04 posted: 2025-07-04 --- +import Requirements from '@macros/iam/requirements.mdx' + In this page, we will show you how to federate your Scaleway metrics using the `/federate` endpoint of your Scaleway data sources with a [Prometheus](https://prometheus.io) configuration. Metrics federation cnsists of collecting metrics from multiple sources or systems into a central place so you can visualize everything at once. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/retrieve-grafana-credentials.mdx b/pages/cockpit/how-to/retrieve-grafana-credentials.mdx index a75bbc57d2..7927e06853 100644 --- a/pages/cockpit/how-to/retrieve-grafana-credentials.mdx +++ b/pages/cockpit/how-to/retrieve-grafana-credentials.mdx @@ -12,10 +12,12 @@ dates: validation: 2024-12-26 posted: 2022-10-31 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to retrieve your Grafana credentials to access your preconfigured [dashboards](/cockpit/concepts/#preconfigured-dashboards) using the [Scaleway console](https://console.scaleway.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/how-to/send-logs-from-k8s-to-cockpit.mdx b/pages/cockpit/how-to/send-logs-from-k8s-to-cockpit.mdx index b096806dad..9d297d3abf 100644 --- a/pages/cockpit/how-to/send-logs-from-k8s-to-cockpit.mdx +++ b/pages/cockpit/how-to/send-logs-from-k8s-to-cockpit.mdx @@ -12,12 +12,16 @@ dates: validation: 2025-01-20 posted: 2025-01-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-cpt-k8s-terraform-logs.webp' + In this page, we will show you how to send application logs from your Kubernetes cluster to your Cockpit using either a Helm chart or deploying a Helm chart with [Terraform](https://www.terraform.io/) or [OpenTofu](https://opentofu.org/). We will use the [k8s-monitoring](https://artifacthub.io/packages/helm/grafana/k8s-monitoring/1.6.16) Helm Chart, which installs an Alloy Daemon set to export your Kubernetes cluster's logs to your Cockpit. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -147,4 +151,4 @@ You can also use Terraform/OpenTofu to manage and deploy Helm charts, providing 7. Optionally, click the **Clock** icon on the top right corner of your screen and filter by time range. 8. Click **Run query** to see your logs. An output similar to the following should display. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/cockpit/how-to/send-metrics-from-k8s-to-cockpit.mdx b/pages/cockpit/how-to/send-metrics-from-k8s-to-cockpit.mdx index ad9bd2872b..9c0c3c6283 100644 --- a/pages/cockpit/how-to/send-metrics-from-k8s-to-cockpit.mdx +++ b/pages/cockpit/how-to/send-metrics-from-k8s-to-cockpit.mdx @@ -12,13 +12,17 @@ dates: validation: 2025-01-20 posted: 2025-01-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-cpt-k8s-terraform-metrics.webp' + On this page, we will show you how to send application metrics from your Kubernetes cluster to your Cockpit, either by using a Helm chart or deploying a Helm chart with [Terraform](https://www.terraform.io/) or [OpenTofu](https://opentofu.org/). We will use the [k8s-monitoring](https://artifacthub.io/packages/helm/grafana/k8s-monitoring/1.6.16) Helm Chart, which installs an Alloy Daemon set to export your Kubernetes cluster's metrics to your Cockpit. - + - A Scaleway account metricsged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -175,4 +179,4 @@ Now that your metrics are exported to your Cockpit, you can access and query the 6. In the **Labels filter** drop-down, select the `cluster` label and in the **Value** drop-down, select your cluster. 7. Optionally, click the **Clock** icon on the top right corner of your screen and filter by time range. 8. Click **Run query** to see your metrics. An output similar to the following should display. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/cockpit/how-to/send-metrics-logs-to-cockpit.mdx b/pages/cockpit/how-to/send-metrics-logs-to-cockpit.mdx index 7dd173f54b..0b37605707 100644 --- a/pages/cockpit/how-to/send-metrics-logs-to-cockpit.mdx +++ b/pages/cockpit/how-to/send-metrics-logs-to-cockpit.mdx @@ -12,11 +12,16 @@ dates: validation: 2025-06-18 posted: 2022-10-31 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-logs-python.webp' +import image2 from './assets/scaleway-explore-python-logs.webp' + This page shows you how to send data such as [metrics](/cockpit/concepts/#metric) and [logs](/cockpit/concepts/#logs) to your [Cockpit](/cockpit/concepts/#cockpit). You can push metrics with any `Prometheus Remote Write` compatible agent such as the [Prometheus](https://prometheus.io/docs/introduction/overview/), [Grafana](https://grafana.com/docs/agent/latest/) or [OpenTelemetry Collector](https://opentelemetry.io/docs/collector/) agents. You can push logs with any Loki compatible agent such as the [Promtail](https://grafana.com/docs/loki/latest/clients/promtail/), [Fluentd](https://docs.fluentd.org/), [Fluent Bit](https://docs.fluentbit.io/manual/) or [Logstash](https://www.elastic.co/guide/en/logstash/current/introduction.html) agents. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -115,9 +120,9 @@ You can push logs with any Loki compatible agent such as the [Promtail](https:// If your logs do not display, try changing the time range to match the time at which you ran your Python file. - + 13. Click the **View in Explore** button for more configuration options. - + Read our more in depth-documentation on [how to configure the Grafana alloy agent](/cockpit/how-to/send-metrics-with-grafana-alloy/) to push your Scaleway metrics, and visualize them in a Grafana dashboard. diff --git a/pages/cockpit/how-to/send-metrics-with-grafana-alloy.mdx b/pages/cockpit/how-to/send-metrics-with-grafana-alloy.mdx index 3e8a2525fd..c81f3cc438 100644 --- a/pages/cockpit/how-to/send-metrics-with-grafana-alloy.mdx +++ b/pages/cockpit/how-to/send-metrics-with-grafana-alloy.mdx @@ -12,6 +12,11 @@ dates: categories: - observability --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-alloy-datasource.webp' +import image2 from './assets/scaleway-alloy-dashboard.webp' + The Grafana Alloy agent is a component used in observability and monitoring setups, to collect and send metrics, logs, and traces from your applications, services, and infrastructure to observability platforms, such as Cockpit. @@ -20,7 +25,7 @@ This page explains how to configure the Grafana Alloy agent to push your metrics For the sake of this documentation, we are using Grafana Alloy on macOS. Refer to the [official Grafana documentation](https://grafana.com/docs/alloy/latest/get-started/) to find the commands to use depending on your operating system of choice. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -109,9 +114,9 @@ For the sake of this documentation, we are using Grafana Alloy on macOS. Refer t 11. In the **Prometheus** field, select your metrics data source in the drop-down. 12. Click **Import**. Your dashboard should load and display. 13. In the drop-down next to **Datasource**, select your metrics data source. By default, your dashboard retrieves your data source's data from the last 24 hours. - + 14. If your data source was created less than 24 hours ago, click the clock icon and adjust the time range to match its creation time. Your dashboard should look similar to the one in the image below. - + diff --git a/pages/cockpit/index.mdx b/pages/cockpit/index.mdx index 3e0ea38d27..05477b937e 100644 --- a/pages/cockpit/index.mdx +++ b/pages/cockpit/index.mdx @@ -51,17 +51,17 @@ meta: - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/reference-content/cockpit-limitations.mdx b/pages/cockpit/reference-content/cockpit-limitations.mdx index 5a6177fd81..56edb17a1d 100644 --- a/pages/cockpit/reference-content/cockpit-limitations.mdx +++ b/pages/cockpit/reference-content/cockpit-limitations.mdx @@ -12,8 +12,10 @@ dates: categories: - observability --- +import CockpitPlanDeprecation from '@macros/cockpit/plan-deprecation.mdx' - + + This page provides information about the capabilities and limits of Scaleway's Observability Cockpit. diff --git a/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx b/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx index 8ef49cc3bd..a8207fb0a4 100644 --- a/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx +++ b/pages/cockpit/reference-content/cockpit-supported-endpoints.mdx @@ -12,6 +12,8 @@ dates: categories: - observability --- +import Requirements from '@macros/iam/requirements.mdx' + Cockpit supports telemetry ingestion and querying using the following open-source technologies: @@ -26,7 +28,7 @@ Cockpit exposes a subset of their HTTP APIs so users can push, query, and manage Scaleway does not support all endpoints from these upstream APIs. Refer to the exact lists below to find out which endpoints are supported. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization or Project diff --git a/pages/cockpit/troubleshooting/index.mdx b/pages/cockpit/troubleshooting/index.mdx index 3193c7bb95..fa6bc56b56 100644 --- a/pages/cockpit/troubleshooting/index.mdx +++ b/pages/cockpit/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: CockpitProductIcon ## Featured Pages - - - - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/cockpit/troubleshooting/resetting-grafana-password-via-the-api.mdx b/pages/cockpit/troubleshooting/resetting-grafana-password-via-the-api.mdx index 72f137f14c..74b0459d80 100644 --- a/pages/cockpit/troubleshooting/resetting-grafana-password-via-the-api.mdx +++ b/pages/cockpit/troubleshooting/resetting-grafana-password-via-the-api.mdx @@ -12,10 +12,12 @@ dates: categories: - observability --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to reset your Grafana user's password through the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created](/iam/how-to/create-api-keys/) an API key with sufficient [IAM permissions](/iam/reference-content/permission-sets/) to perform the actions described on this page diff --git a/pages/cockpit/troubleshooting/synchronize-grafana-data-sources.mdx b/pages/cockpit/troubleshooting/synchronize-grafana-data-sources.mdx index 3287c1e8bf..2bc22ea557 100644 --- a/pages/cockpit/troubleshooting/synchronize-grafana-data-sources.mdx +++ b/pages/cockpit/troubleshooting/synchronize-grafana-data-sources.mdx @@ -12,6 +12,10 @@ dates: categories: - observability --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_cpt_grafana_datasources_troubleshooting.webp' + This page shows you how to visualize your data again when it does not display on your Grafana dashboards, using the `SyncGrafanaDataSources` [endpoint](https://www.scaleway.com/en/developers/api/cockpit/global-api/#path-grafana-synchronize-grafana-data-sources) of the [Cockpit Global API](https://www.scaleway.com/en/developers/api/cockpit/global-api/#path-grafana-synchronize-grafana-data-sources) or the [Scaleway CLI](https://cli.scaleway.com/cockpit/#get-your-cockpits-grafana). @@ -19,7 +23,7 @@ This page shows you how to visualize your data again when it does not display on The [Cockpit Global API](https://www.scaleway.com/en/developers/api/cockpit/global-api/#path-grafana-synchronize-grafana-data-sources) contains deprecated information that is being updated, you should not use it for any other purpose than the one described on this page. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created](/iam/how-to/create-api-keys/) an API key with sufficient [IAM permissions](/iam/reference-content/permission-sets/) to perform the actions described on this page @@ -33,7 +37,7 @@ This page shows you how to visualize your data again when it does not display on When users open their Grafana dashboards, they see a `No data` message along with an error banner stating: `Failed to upgrade legacy queries datasource was not found`. - + - Your Cockpit is unavailable. - You cannot view your logs and/or metrics in Grafana. diff --git a/pages/components/assets/first-scaleway-chip.webp b/pages/components/assets/first-scaleway-chip.webp deleted file mode 100644 index a26a3b1f65..0000000000 Binary files a/pages/components/assets/first-scaleway-chip.webp and /dev/null differ diff --git a/pages/components/assets/icon.webp b/pages/components/assets/icon.webp deleted file mode 100644 index 9189a54795..0000000000 Binary files a/pages/components/assets/icon.webp and /dev/null differ diff --git a/pages/components/assets/miam.webp b/pages/components/assets/miam.webp deleted file mode 100644 index a4fa997a12..0000000000 Binary files a/pages/components/assets/miam.webp and /dev/null differ diff --git a/pages/components/assets/root-create-account.webp b/pages/components/assets/root-create-account.webp deleted file mode 100644 index 28d942e9e4..0000000000 Binary files a/pages/components/assets/root-create-account.webp and /dev/null differ diff --git a/pages/components/assets/scaleway-flex-drag.gif b/pages/components/assets/scaleway-flex-drag.gif deleted file mode 100644 index 2475097a80..0000000000 Binary files a/pages/components/assets/scaleway-flex-drag.gif and /dev/null differ diff --git a/pages/components/docs-editor.mdx b/pages/components/docs-editor.mdx deleted file mode 100644 index c19d5d6ff3..0000000000 --- a/pages/components/docs-editor.mdx +++ /dev/null @@ -1,643 +0,0 @@ ---- -meta: - title: Navigation and layout components - description: Display all components used for documentation pages layout - noindex: true -content: - h1: Navigation and layout components - paragraph: Display all components used for documentation pages layout ---- - -## Buttons - -### Navigation - -🧩  This component uses a **Tag** style. - -**Code example:** - -```jsx - - Previous - Next - -``` -**Render:** - - - Previous - Next - - -#### Navigation with title - - - Previous - Next - - -#### Navigation with one button - - - Previous - - - - Lorem ipsum dolor sit amet - - ---- - -### Steps & StepButton - -🧩  This component uses a **Tag** style. - -**Code example:** - -```jsx - - How-to create an Instance - How-to create an account - -``` - -**Render:** - - - How-to create an account - - -### Two steps - - - How-to create an Instance - How-to create an account - - ---- - -## ClickableBanner - -🧩  This component uses a **Tag** style. - - -**Code example:** - -### With a product logo - -```jsx - -``` -**Render:** - - - - -### Without a product logo - -**Code example:** - -```jsx - -``` - -**Render:** - - - ---- - - -## DefaultCard - -🧩  This component uses a **Tag** style. - -Props: -- `title` (mandatory!) -- `tags` (use OBJECT array) -- `description` -- `url` (for link) -- `label` (for link) - -**Code example:** - -```jsx - -``` - -**Render:** - - - -### Minimal - - - -### Linked - - - -### Linked, no description & default label - - - -### Linked & tags, without description - - - ---- - -## GeneralLinks - -⚙️  This component is a "system codebase" component. - - - - - - - - - ---- - -## Grid - -🧩  This component uses a **Tag** style. - - -**Code example:** - -```jsx - - - - - - - - - -``` -**Render:** - -Example using `DefaultCard` in `Grid` wrapper. - - - - - - - - - - - ---- - -## HelpBanner - -🧩  This component uses a **Tag** style. - -**Code example:** - -```jsx - -``` - -**Render** - - - - ---- - -## LinksList - - -🧩  This component uses a **Tag** style. - -⚠️ Use a `native markdown list` in `LinksList` component for each `LinkList` - - -**Code example:** - -```jsx - - - [My secrets and variables are not injected properly in my functions](/path-to-page) - - [My function falls after trying too many times](/path-to-page) - - [My function is an error state](/path-to-page) - - [Tests fail on Serverless Functions](/path-to-page) - - [Unable to find the function handler](/path-to-page) - - [I am unable to create a Serverless Functions namespace](/path-to-page) - - [I am experiencing timeout errors](/path-to-page) - -``` -**Render:** - -## Example link list - - - - - - - - - - - - - - - - - ---- - - -## Log (Changelog) - -🧩  This functionnality uses **MDX** files. - -⚙️  This is a "system codebase" feature. - -See [Changelog page](https://www.scaleway.com/en/docs/changelog/). - -Each "Log" is MDX file: - -- Go to `changelog/` folder -- Add or choose a directory relative to the log you want to add -- Create a `.mdx` file in it - -NOTES: -- Organize `changelog/` folder structure as you want -- The `.mdx` filename does not matter -- Assets should be in a `asset` directory, sibling of your `.mdx` file - -### Log file frontmatter - -At top of `.mdx` file, you MUST add data in frontmatter: - -``` ---- -title: Migration to the new Object Storage backend (HIVE) for all regions -status: changed -author: - fullname: 'Join the #container-registry channel on Slack.' - url: 'https://slack.scaleway.com/' -date: 2022-01-02 -category: compute -product: container-registry ---- -``` - -- **title** (mandatory) -- **status** (mandatory) - - `added` - - `security` - - `changed` - - `deprecated` - - `removed` - - `fixed` -- **author** - - **fullname** (optional / mandatory IF url is set) It could be a name or a sentence if you please. - - **url** (optionnal) -- **date** (mandatory) `YYYY-MM-DD` -- **category** (mandatory) `kebab-case` -- **product** (mandatory) `kebab-case` - -### Log file contents - -The content section works as any documentation `.mdx` file. It accept markdown and Components as well. Be concise ! - - -## ChangelogList - -🧩  This component uses a **Tag** style. - -The ChangelogList component is used to display the latest entries of the changelog, in a particular page. - -### Display all products - -If there is no product name passed to the component, the list will display the X latest changes from the changelog: - -**Code example:** - -```html - -``` -**Render:** - - - -### Display only the changes for a specific product - -By adding a product name to the component, the list will display the X latest changes from the changelog for this product: - -**Code example:** - -```html - -``` -**Render:** - - - -#### About Download link in content - -🧩  This feature uses a **native-extended Markdown** style. - -- Use `[Download](document-pdf-name.pdf) the document as PDF file.` -- Place the PDF file at a sibling assets directory - - This is usefull to automatically get the filesize data -- Then it should appear like this (with PDF icon): - - > 📄 Download (PDF, 2.26MB) the document as PDF file. - ---- - -## ProductCard - -🧩  This component uses a **Tag** style. - -Props: -- `productIcon` (mandatory!) - Icon name from Ultraviolet lib -- `title` (mandatory!) -- `description` -- `url` (for link, mandatory!) - -**Code example:** - -```jsx - -``` - -**Render:** - -### Full example - - - - ---- - -## ProductHeader - -Props: - -- `productName` (mandatory!) -- `description` -- `productLogo` -- `url` (for link) -- `label` (for link) - -**Code example:** - -```jsx - -``` - -**Render:** - - - -### Without logo - - - ---- - -## SummaryCard - -There is 4 SummaryCard using props mentionned below. - -The `icon` names are not random ones they come from Ultraviolet lib. - - -**Code example:** - -```jsx - -``` - -**Render:** - - - - - - - - - - - - ---- - -## Ultraviolet illustrations - -Here is a list of current Ultraviolet illustrations available - - - ---- - -## Ultraviolet product icons - -Here is a list of current Ultraviolet product icons available - - - ---- - -## GuideFlow Integration - - - - -## StoryLane Integration - - - ---- - -## Illustration Cards - -Here is an example of a card component using illustrations with its troubleshooting link and automatically placed due to `IllustrationCardsContainer` wrapping each manually added cards. - -```jsx - - - - - - - -``` - - - - - - - - - - - - - - - - - - - - - ---- diff --git a/pages/components/docs.mdx b/pages/components/docs.mdx deleted file mode 100644 index 82b06e5c64..0000000000 --- a/pages/components/docs.mdx +++ /dev/null @@ -1,878 +0,0 @@ ---- -meta: - title: Content components - description: Display all components used in documentation pages - noindex: true -content: - h1: Content components - paragraph: Display all components used in documentation pages ---- - -Feel free to explore this page in your markdown editor (`/docs/components/docs.mdx`) to see how the components were used, or in MDX content files that already use MDX components. - ---- - -MDX components are useful for adding rich content and interactions within your contributions. - -There are two types of components: - - **Native** (or _native-extended_) markdown style - - **Tag** style (some kind of html tag) - ---- - -## Code - -🧩  This component uses a **native-extended Markdown** style. - -Use a triple backquote character ` ``` ` to enclose text - -You can specify the language of the code. -A list of languages can be found [here](https://prismjs.com/#supported-languages). - -**Component examples** - -``` -this is a block of code -``` - -The following example uses the JSX language, i.e. ` ```jsx `: - -```jsx -import React, { useState } from 'react' - -function Example() { - const [count, setCount] = useState(0) - - return ( -
-

You clicked {count} times

- -
- ) -} -``` - -With bash script, i.e ` ```bash ` - -```bash -WEEK=`date '+%W'` # The week of the year (0..53). -WEEK=${WEEK#0} # Remove possible leading zero. -let "INDEX = $WEEK % $COUNT" # week modulo count = the lucky person -COMPAGNON=${COMPAGNONS_LIST[INDEX]} # Get the lucky person's e-mail address. -``` - -With no language, i.e. ` ``` ` - -``` -server { - listen 212.d.e.f:80n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8; - - server_name site2.tld; - - root /var/www/site2; - index index.html; - - location / { - try_files $uri $uri/ =404; - } -} -``` - ---- - -## Concept - -🧩  This component uses a **Tag** style. - -**Component example #1** - -The first child has to be an `h2` - - - ## Concept with string - - Content string - - -**Component example #2** - - - ## Concept with MDX - - ``` - server { - root /var/www/site2; - index index.html; - - location / { - try_files $uri $uri/ =404; - } - } - ``` - - - - - Lorem ipsum dolor sit amet, **consectetur adipisicing** elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - - - - -**Code example** - -```jsx - - ## The first child has to be an `h2` - - You can use simple text and even MDX components here like Message, Lightbox, Code, etc - -``` - ---- - -## Definition list - -🧩  This component uses a **native-extended Markdown** style. - -- List items should be separated with a line break. -- If you want to include two separate definition lists, there must be a line of text separating them. Otherwise, the lists will be stuck together. - -Description -: Root-level tag for the ObjectLockConfiguration parameters. - -Random text to separate the lists. It can be a title or inline code. - -Description -: Indicates whether this bucket has an Object Lock configuration enabled - -Type -: String - -Valid Values -: `Enabled` - -Required -: Yes - -**Code example** - -```html -Description -: Indicates whether this bucket has an Object Lock configuration enabled - -Type -: String - -Valid Values -: `Enabled` - -Required -: Yes -``` - ---- - -## Headings - -🧩  This component uses a **Native Markdown** style. - -# H1 title - -Voluptate commodo eu consectetur sint proident et Lorem amet officia mollit cupidatat. Proident in ullamco eiusmod veniam quis non qui minim elit veniam ullamco eu. Ea duis enim sint incididunt exercitation tempor irure veniam. Fugiat labore veniam magna dolor anim deserunt deserunt laboris. - -## H2 title - -Eu minim consectetur pariatur deserunt est esse anim ullamco do deserunt consequat sit irure. Esse aute adipisicing ullamco non eu ex ut dolore incididunt veniam aliqua est. Ea ex laboris eiusmod eiusmod ut. Ipsum veniam officia elit nisi est consequat Lorem ut magna anim duis. Occaecat commodo sint ipsum reprehenderit deserunt elit duis. - -### H3 title - -Do enim nisi laborum aliqua magna anim magna officia velit. Excepteur minim nostrud in laboris incididunt cillum consectetur laborum sit. Eu cillum sit irure excepteur. Voluptate aute fugiat ullamco sint ullamco laborum voluptate deserunt incididunt in mollit enim. Quis nisi laborum id nulla nisi amet est. - -#### H4 title - -Deserunt id culpa aliqua exercitation exercitation officia amet ea ea. Sit aliqua tempor Lorem incididunt amet elit dolor. Ullamco commodo nisi ullamco adipisicing officia nisi. Nulla amet nostrud minim cupidatat aute labore. - -##### H5 title - -Cillum cupidatat aute Lorem amet laborum cillum occaecat adipisicing excepteur. Nisi proident reprehenderit proident veniam nisi sit eu anim deserunt Lorem irure pariatur ad incididunt. Esse commodo officia elit id aliquip dolore commodo. Lorem amet labore in consectetur laborum cillum tempor mollit anim laboris velit aute do. Ex sunt elit irure deserunt laboris ullamco amet Lorem amet tempor deserunt qui. - -###### H6 title - -Nulla labore qui aliqua minim adipisicing. Ut irure Lorem consectetur incididunt reprehenderit veniam id duis mollit. Consectetur ullamco Lorem excepteur magna sit excepteur duis nisi aliqua veniam cupidatat enim. Aute eiusmod duis enim non adipisicing incididunt enim aute laborum proident. Ea nulla sit laborum consectetur laborum minim tempor cillum do sunt deserunt laborum. Velit laborum deserunt laborum eiusmod qui dolore enim irure laborum deserunt enim nostrud cillum Lorem. - -**Code example** - -```html -## Heading title level 2 - -Lorem ipsum - -### Heading title level 3 - -Lorem ipsum - -#### Heading title level 4 - -Lorem ipsum - -##### Heading title level 5 - -Lorem ipsum - -###### Heading title level 6 - -Lorem ipsum -``` - ---- - -## Inline Code - -🧩  This component uses a **Native Markdown** style. - -To use code style in the middle of text lines, enclose the text with a single backquote (`) character - -Hello, `I'm inline code`. Call the function `getMoreLove()`. This is my IP address: `192.168.1.1`. - -**Code example** - -```html -…this is a normal inline text using single quotes `192.168.0.1` for IP. -``` - -…this is a normal inline text using single quotes `192.168.0.1` for IP. - ---- - -## Inline Console icons - -🧩  This component uses a **Tag** style. - -Inline Console icons are used in the text. They are the same as the Scaleway Console icons. - -- The MDX is a TAG named `Icon` -- Mandatory 'name' attribute is used with keys - -Keys are: -- `assistance`, -- `delete`, -- `download`, -- `cancel`, -- `edit`, -- `glacier`, -- `more`, -- `plus`, -- `toggle`, -- `unlink`, -- `validate`, - -Voluptate commodo eu consectetur sint proident et Lorem amet officia mollit cupidatat . Proident in ullamco eiusmod veniam quis non qui minim elit veniam ullamco eu . Ea duis enim sint incididunt exercitation tempor irure veniam. Fugiat labore veniam magna dolor anim deserunt deserunt laboris. - -Eu minim consectetur pariatur deserunt est esse anim ullamco do deserunt consequat sit irure . Esse aute adipisicing ullamco non eu ex ut dolore incididunt veniam aliqua est. Ea ex laboris eiusmod eiusmod ut. Ipsum veniam officia elit nisi est consequat Lorem ut magna anim duis. Occaecat commodo sint ipsum reprehenderit deserunt elit duis. - -**Code example** - -```jsx -…this is a normal inline text with an icon. -``` - ---- - -## Images - -🧩  This component uses a **Native Markdown** OR a **Tag** style. - -![MD basic image maker](https://placekitten.com/300/200) - - - -**Code example** - -```jsx -// Native Markdown -![MD basic image maker](https://placekitten.com/300/200) - -// HTML Tag - -``` - ---- - -## Lightbox - -🧩  This component uses a **Tag** style. - -Props: `src` (mandatory): - -```jsx - -``` - -### Different size (by default medium): - -Props: `size="[small|medium|large]"` - -#### Small: - - -#### Medium: - - -#### Large: - - -### Can be grouped - -#### With 2 small images: - - -```jsx - -``` - -#### With 2 medium images: - - -```jsx - -``` - -#### With 3 small images: - - -```jsx - -``` - -### Can handle .gif - - - - -```jsx - - -``` - -### About accessibility - -#### With Prop `alt` (optional): -```jsx - -``` - - - - -#### With prop `longdesc` (optional): -```jsx - -``` - ---- - -## Link - -🧩  This component uses a **Native Markdown** OR a **Tag** style. - -- Internal - - `[]()` Native syntax: [Tutorials](/tutorials/) - ```md - [Tutorials](/tutorials) - ``` - - `[]()` PDF: [Latest changes of the week](new-changes.pdf) - ```md - - [Latest changes of the week](new-changes.pdf) - ``` -- External - - `[]()` Native syntax: [Tutorials](https://console.scaleway.com) - ```md - [Tutorials](https://console.scaleway.com) - ``` - ---- - -## Lists - -🧩  This component uses a **Native Markdown** style. - -### Ordered list - -Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. - -1. First -2. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. - -3. Third -4. fourth - ![simple image in list](https://placekitten.com/1000/460) -5. fifth - ```jsx - 1. First - 2. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. - - 3. Third - 4. fourth - ![simple image in list](https://placekitten.com/1000/460) - 5. fifth - ``` - -### Unordered list - -- First - - First Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore - - First -- Second Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore -- Third - -```html -- First - - First Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore - - First -- Second Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore -- Third -``` - -### Ordered list with a new line - -1. List number 1 - - New line, still in number 1 -2. List number 2 **with code block inside** - ``` - server { - listen 212.d.e.f:80n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8; - - server_name site2.tld; - - root /var/www/site2; - index index.html; - - location / { - try_files $uri $uri/ =404; - } - } - ``` - I don't know mnI don't know mnI don't know mnI don't know mn -3. List number 3 here - -### Nested lists - -1. Click **Instances** in the **Compute** section of the side menu. The Instance creation page displays. -2. Click the **Create an Instance** button. The Instance creation wizard displays: -3. You can now make those steps - - Choose an **Availability Zone**, which is the geographical region where your instance will be deployed - - under - - line - - Choose an **Image** to run on your instance. This can be an operating system, an InstantApp or a custom image. - - Choose an **Instance type**. Different instance types have different prices, processing power, memory, SSD disks and bandwidth. - - Add **Volumes**. This is an optional step. You can leave the default settings for storage, or choose to add more [block](link) or [local](link) storage to your instance. - - Enter a **Name** for your instance, or leave the randomly-generated name in place. Optionally, you can also add tags to help you organize your instances. - - Click **Advanced Options** if you wish to configure a flexible IP, a local bootscript or a cloud-init configuration. - - Verify the **SSH Keys** that will be give you access to your Instance - - Verify the **Estimated Cost** of your instance, based on the specifications you chose. -4. Click **Create a new instance** to finish. The creation of your instance is started, and you are informed when the instance is ready. -5. Complete the following information: - - Frontend rules include: - - Frontend rule name - - Port - - SSL Certificate - - Backend rules include: - - Backend rule name - - Protocol: TCP or HTTP - - Port - - Proxy - - Health check type - - Sticky session - - Server IP - - You can also use an existing backend. - To do so, click **Use an existing Backend** and select the backend of your choice from the dropdown list. - -6. Click **Create Frontend** - **Code example** - - ```jsx - 1. Click **Instances** in the **Compute** section of the side menu. The Instance creation page displays. - 2. Click the **Create an Instance** button. The Instance creation wizard displays: - 3. You can now make those steps - - Choose an **Availability Zone**, which is the geographical region where your instance will be deployed - - under - - line - - Choose an **Image** to run on your instance. This can be an operating system, an InstantApp or a custom image. - - Choose an **Instance type**. Different instance types have different prices, processing power, memory, SSD disks and bandwidth. - - Add **Volumes**. This is an optional step. You can leave the default settings for storage, or choose to add more [block](link) or [local](link) storage to your instance. - - Enter a **Name** for your instance, or leave the randomly-generated name in place. Optionally, you can also add tags to help you organize your instances. - - Click **Advanced Options** if you wish to configure a flexible IP, a local bootscript or a cloud-init configuration. - - Verify the **SSH Keys** that will be give you access to your Instance - - Verify the **Estimated Cost** of your instance, based on the specifications you chose. - 4. Click **Create a new instance** to finish. The creation of your instance is started, and you are informed when the instance is ready. - 5. Complete the following information: - - Frontend rules include: - - Frontend rule name - - Port - - SSL Certificate - - Backend rules include: - - Backend rule name - - Protocol: TCP or HTTP - - Port - - Proxy - - Health check type - - Sticky session - - Server IP - - You can also use an existing backend. - To do so, click **Use an existing Backend** and select the backend of your choice from the dropdown list. - - 6. Click **Create Frontend** - ``` - ---- - -## Macro - -🧩  This component uses a **Tag** style. - -A `macro` is a piece of content written in MDX which can be re-used anywhere. - - - -^^^^ -The above text come from a macro! - -**Code example** - -```jsx - -``` - ---- - -## Messages - -🧩  This component uses a **Tag** style. - - - This `Message` has no `type` at all. So It is 'note' type by default. - - - - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse - cillum dolore eu fugiat nulla pariatur. - - - - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse - cillum dolore eu fugiat nulla pariatur. - - - - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse - cillum dolore eu fugiat nulla pariatur. - - - - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse - cillum dolore eu fugiat nulla pariatur. - - - - Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo - consequat. - - - - * First item - * Second item - - 1. First item - 2. Second item - - - - `listen 212.d.e.f:80n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8n 212.d.e.f:8;` - - - - **Lorem** ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - - -⚠️ Note that markdown table inside a `Message` must not start with a tab. - - -| Content Type | Description | Number | -| ------------ | ------------------- | ------ | -| Hello | Three columns table | 1 | -| Tutorials | New concept | 2 | - - - **Lorem** ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - - - First item - - Second item - - **Important item** - - `Some code` - - - - -**Code example** - -```jsx - - **Lorem** ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam. - - - First item - - Second item - - **Important item** - - `Some code` - -``` - - -```jsx - -| Content Type | Description | Number | -| ------------ | ------------------- | ------ | -| Hello | Three columns table | 1 | -| Tutorials | New concept | 2 | - - - **Lorem** ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod - tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, - - - First item - - Second item - - **Important item** - - `Some code` - - - -``` - ---- - -## Table - -🧩  This component uses a **Native Markdown** style. - -| Content Type | Description | -| :-------------------------------------------------- | :---------------------------------------------------------------------------- | -| Videos | Left-aligned table | -| is overflowed ? | verylongwordtocheckifthereissomevieportoverflowsinsmallmobilewidths | -| How-tos | Problem-oriented, we take you through a series of steps to reach a real goal. | -| [Scaleway Onboarding guide](new-changes.pdf) | Learning-oriented, we take you through a series of steps to learn a concept | - -| Content Type | Description | -| :-----------------------------------------------------: | :---------------------------------------------------------------------------: | -| [Internal link](/dedibox-account/quickstart/) | Centered-align table | -| [External link](https://www.scaleway.com) | Problem-oriented, we take you through a series of steps to reach a real goal. | -| Tutorials | Learning-oriented, we take you through a series of steps to learn a concept | - -| Content Type | Description | -| -----------: | --------------------------------------------------------------------------: | -| Hello | Right-align table | -| Tutorials | Learning-oriented, we take you through a series of steps to learn a concept | - -| Content Type | Description | Number | -| ------------ | ------------------- | ------ | -| Hello | Three columns table | 1 | -| Tutorials | New concept | 2 | - -**Code example** - -```md -| Content Type | Description | Number | -| ------------ | ------------------- | ------ | -| Hello | Three columns table | 1 | -| Tutorials | New concept | 2 | -``` - ---- - - -## Tabs - -🧩  This component uses a **Tag** style. - -**Component example #1** - - - - Hello Tabs - - - - - - - CONSOLE - 1. Click **Instances** in the **Compute** section of the side menu. The Instance creation page displays. - - - If you have existing Instances in your account, you will see a list of - these Instances instead of the Instance creation page, and the - button for creating new Instances. - - 2. Click **Create an Instance**. The Instance creation wizard displays. - - 3. Complete the following steps in the wizard: - - Choose an **Availability Zone**, which is the geographical region where your Instance will be deployed. - - Choose an **Image** to run on your Instance. This can be an operating system, an InstantApp or a custom image. A complete list of all available Linux distributions and InstantApps can be found [here](https://www.scaleway.com/en/imagehub/). - - When choosing an image for an Enterprise Instance, be aware this Instance type is not compatible with bootscripts, except for [rescue mode](/instances/how-to/use-boot-modes/#how-to-use-rescue-mode). InstantApps are also not available for this Instance type. - - - Choose an **Instance type**. Different Instance types have different prices, processing power, memory, storage options and bandwidth. - - Add **Volumes**. Volumes are storage spaces used by your Instances. - - For **GP1 Instances** you can leave the default settings of a maximum local storage, or choose how much [local](/instances/concepts/#local-volumes) and/or [block](/instances/concepts/#block-volumes) storage you want. Your **system volume** is the volume on which your Instance will boot. The system volume can be either a local or a block volume. - - **PRO2** and **Enterprise** Instances boot directly [on block volumes](/instances/concepts/#boot-on-block). You can add several block volumes and define how much storage you want for each. - - Please note that: - - a volume with an OS image should be at least 10GB (125GB for a GPU OS). - - if several Block Storage volumes are connected to your Instance, the first volume will contain the OS and is required to boot the Instance. You can [change your boot volume](/instances/how-to/use-boot-modes/#how-to-change-the-boot-volume) after you create the Instance. - - if you have two or more volumes with identical operating systems, or a volume with no operating system, choosing one of these as your boot volume may cause unpredictable boot behavior. - - - Enter a **Name** for your Instance, or leave the randomly-generated name in place. Optionally, you can also add [tags](/instances/concepts/#tags) to help you organize your Instance. - - Click **Advanced Options** if you want to configure a [flexible IP](/instances/concepts#flexible-ip), a local bootscript or a [cloud-init configuration](/instances/concepts#cloud-init). Otherwise, leave these options at their default values. - - Verify the [SSH Keys](/account/concepts#ssh-key) that will give you access to your Instance. - - Verify the **Estimated Cost** of your Instance, based on the specifications you chose. - 4. Click **Create a new Instance** to finish. The creation of your Instance begins, and you will be informed when the Instance is ready. - - Your Instance is now created and you are redirected to the **Overview** tab. From here, you can see information including your Instance's Public IP, the SSH command to use to [connect to it](/instances/how-to/create-an-instance/), and other information, settings, and actions for the Instance. - - - API - - The following command and request body creates an Instance via the API using `curl`. - - You need to replace `{zone}` in the URL with the desired zone, and the various placeholder values in the payload (`"string"`, `"boolean"` etc) with the desired values, according to the type of Instance you want to create. See the dedicated section of the [API reference](https://developers.scaleway.com/en/products/instance/api/#post-7482b1) for full details. - - ```bash - curl -H 'X-Auth-Token: $SECRET_KEY' -H 'Content-Type: application/json' \ - https://api.scaleway.com/instance/v1/zones/{zone}/servers -d \ - '{ - "name": "string", - "dynamic_ip_required": boolean, - "commercial_type": "string", - "image": "string", - "volumes": { - "": { - "id": "string", - "boot": boolean, - "name": "string", - "size": 300000000000, - "volume_type": "l_ssd", - "base_snapshot": "string", - "organization": "string", - "project": "string" - } - }, - "enable_ipv6": boolean, - "public_ip": "string", - "boot_type": "local", - "bootscript": "string", - "organization": "string", - "project": "string", - "tags": [ - "string" - ], - "security_group": "string", - "placement_group": "string" - }' - ``` - - Here is an example of a complete curl request to create a GP1-S Instance in the `fr-par-1` zone, called "my-instance" running Ubuntu 20.04 Focal Fossa in the Organization `"3ei11278-827c-4c34-8111-0c2576ed921f`. You can see that many of the optional values from the full command above have been omitted: - - ```bash - curl -H "X-Auth-Token: $SECRET_KEY" -H "Content-Type: application/json" https://api.scaleway.com/instance/v1/zones/fr-par-1/servers -d \ - '{ - "name": "my-instance", - "commercial_type": "GP1-S", - "image": "881d7a33-4cfa-4046-b5cf-c33cb9c62fb6", - "boot_type": "local", - "organization": "3ei11278-827c-4c34-8111-0c2576ed921f", - "tags": [ - "my-tag" - ] - }' - ``` - - - This is a tab without label and default fallback tab name - - - - - -**Code example** - -```html - - - Lorem Ipsum - - - 1. Rich content - 2. Using MDX components - - - - - If you have existing Instances - in your account, you will see a list of - these Instances instead of the - Instance creation page, and the - button for creating new Instances. - - - -``` - -⚠️ Do not forget to add the `id` props on ``. It's needed to distinguish multiples tabs snippet on a same page ⚠️ - ---- - - -## Help banner - -**Component example #1** - - - - -**Code example** - -```html - -``` - ---- - - - - - diff --git a/pages/components/index.mdx b/pages/components/index.mdx deleted file mode 100644 index ad502ad973..0000000000 --- a/pages/components/index.mdx +++ /dev/null @@ -1,9 +0,0 @@ ---- -meta: - title: Components listing - description: Display all components - noindex: true -content: - h1: Components - paragraph: Display all components ---- \ No newline at end of file diff --git a/pages/container-registry/how-to/connect-docker-cli.mdx b/pages/container-registry/how-to/connect-docker-cli.mdx index 190f8d59be..1e5aac8372 100644 --- a/pages/container-registry/how-to/connect-docker-cli.mdx +++ b/pages/container-registry/how-to/connect-docker-cli.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + Docker is a tool that makes it easy to manage container images. You can use Docker to push and pull images to and from your Scaleway Container Registry. We show you how to set up Docker on your local computer to connect to your Container Registry. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/create-namespace.mdx b/pages/container-registry/how-to/create-namespace.mdx index 90709073de..1536cd97bb 100644 --- a/pages/container-registry/how-to/create-namespace.mdx +++ b/pages/container-registry/how-to/create-namespace.mdx @@ -12,12 +12,14 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Container Registry](/container-registry/concepts/#container-registry) is a fully-managed, mutualized container registry, designed to facilitate the storage, management, and deployment of container images. The service simplifies the development-to-production workflow, as there is no need to operate your own Container Registry or worry about the underlying infrastructure. Within your Container Registry, [namespaces](/container-registry/concepts/#namespace) allow you to manage your registry in a clear, simple and human-readable way. A namespace is a collection of container images, each bearing the unique identifier of that namespace. To start using your Container Registry, you first need to create a namespace. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/delete-image.mdx b/pages/container-registry/how-to/delete-image.mdx index e93f1d2631..eb75437171 100644 --- a/pages/container-registry/how-to/delete-image.mdx +++ b/pages/container-registry/how-to/delete-image.mdx @@ -12,8 +12,10 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/delete-namespace.mdx b/pages/container-registry/how-to/delete-namespace.mdx index 75ca10c3d5..d451fc3f36 100644 --- a/pages/container-registry/how-to/delete-namespace.mdx +++ b/pages/container-registry/how-to/delete-namespace.mdx @@ -12,8 +12,10 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/display-image-versions.mdx b/pages/container-registry/how-to/display-image-versions.mdx index 036a42a757..5acb0c845a 100644 --- a/pages/container-registry/how-to/display-image-versions.mdx +++ b/pages/container-registry/how-to/display-image-versions.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Container Registry supports image versioning. This allows you to track any changes in your container image versions, and easily revert your deployment if needed. You can choose which image version you want to pull, and delete any versions that you no longer need. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/manage-image-privacy-settings.mdx b/pages/container-registry/how-to/manage-image-privacy-settings.mdx index 23cb8754bf..c5d985147d 100644 --- a/pages/container-registry/how-to/manage-image-privacy-settings.mdx +++ b/pages/container-registry/how-to/manage-image-privacy-settings.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + The [image privacy policy](/container-registry/concepts/#image-privacy-policies) specifies whether everyone is granted access to pull the image or not. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/manage-namespace-privacy-policies.mdx b/pages/container-registry/how-to/manage-namespace-privacy-policies.mdx index df5431d7ab..f2c23e113c 100644 --- a/pages/container-registry/how-to/manage-namespace-privacy-policies.mdx +++ b/pages/container-registry/how-to/manage-namespace-privacy-policies.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + A namespace's privacy policy specifies whether everyone is granted access to pull its images or not. Everyone will be able to pull container images from a public namespace. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/pull-images.mdx b/pages/container-registry/how-to/pull-images.mdx index 6c1942d00b..349611838f 100644 --- a/pages/container-registry/how-to/pull-images.mdx +++ b/pages/container-registry/how-to/pull-images.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + After [configuring Docker on your local machine](/container-registry/how-to/connect-docker-cli/), you can use it to pull images from your Container Registry. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/how-to/push-images.mdx b/pages/container-registry/how-to/push-images.mdx index c1af9f68fb..d1fb66dd94 100644 --- a/pages/container-registry/how-to/push-images.mdx +++ b/pages/container-registry/how-to/push-images.mdx @@ -12,10 +12,12 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + After [configuring Docker on your local machine](/container-registry/how-to/connect-docker-cli/), you can use it to pull images from their library and push them to your Container Registry. This page shows you how to pull, tag, and push a first image to your Scaleway Container Registry namespace, using an Ubuntu image as an example. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/container-registry/index.mdx b/pages/container-registry/index.mdx index 509981fb1a..0a0037a17e 100644 --- a/pages/container-registry/index.mdx +++ b/pages/container-registry/index.mdx @@ -42,22 +42,22 @@ meta: ## Tutorials - - - - \ No newline at end of file +/> diff --git a/pages/container-registry/quickstart.mdx b/pages/container-registry/quickstart.mdx index 994ca0bd31..16a313cdf0 100644 --- a/pages/container-registry/quickstart.mdx +++ b/pages/container-registry/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway [Container Registry](/container-registry/concepts/#container-registry) is a fully-managed mutualized container registry, designed to facilitate the storage, management, and deployment of container images. The service simplifies the development-to-production workflow, as there is no need to operate your own Container Registry or worry about the underlying infrastructure. You can create your Container Registry namespace, connect it to the Docker CLI, then use Docker to push and pull images to and from your registry. When you no longer need an image, you can delete it from your Container Registry. @@ -19,7 +21,7 @@ Scaleway [Container Registry](/container-registry/concepts/#container-registry) Discover the Container Registry interface in the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -41,7 +43,7 @@ Discover the Container Registry interface in the Scaleway console. ## How to connect your namespace to the Docker CLI - + - Installed [Docker](https://www.docker.com/) on your local computer - [Generated your API key](/iam/how-to/create-api-keys/) diff --git a/pages/container-registry/troubleshooting/index.mdx b/pages/container-registry/troubleshooting/index.mdx index b66642758b..57d5be2e2b 100644 --- a/pages/container-registry/troubleshooting/index.mdx +++ b/pages/container-registry/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: RegistryProductIcon ## Featured Pages - - - +import image from './assets/scaleway_hosting1.webp' +import image2 from './assets/scaleway_hosting_2.webp' +import image3 from './assets/scaleway_dashboard_cpanel.webp' +import image4 from './assets/scaleway_domain_cpanel1.webp' +import image5 from './assets/scaleway_list_of_domains.webp' +import image6 from './assets/scaleway_status_of_domain_names.webp' + + + cPanel is a website management control panel tool, providing users with a graphical interface and fast access icons which allow the configuration and monitoring of their hosting solutions. Features like publishing websites, launching databases, creating emails, and managing files are available through the cPanel interface with elevated performance. @@ -34,9 +43,9 @@ Not sure where to begin? Take a look at our Frequently Asked Questions, which gu Click **Dashboard** to access the link to your cPanel administration interface which is available in your hosting homepage. - - - + + + ## How to access the webmail @@ -53,10 +62,10 @@ Nameservers are servers used to translate domain names into IP addresses. When y 1. From the console, click **Domain** on the upper menu of the Scaleway Dedibox console. A list of your domain names displays. - + 2. Click the **Configure domain name** action of the domain you wish to set up. The **Status of domain name** page displays. - - + + 3. Click the **Manage DNS Servers** tab to find a list of your nameservers. 4. Erase the old addresses. 5. Include the new cPanel nameservers. diff --git a/pages/data-lab/how-to/connect-to-data-lab.mdx b/pages/data-lab/how-to/connect-to-data-lab.mdx index 8008d54bb1..b9ef89b745 100644 --- a/pages/data-lab/how-to/connect-to-data-lab.mdx +++ b/pages/data-lab/how-to/connect-to-data-lab.mdx @@ -13,8 +13,10 @@ categories: - managed-services - data-lab --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-lab/how-to/create-data-lab.mdx b/pages/data-lab/how-to/create-data-lab.mdx index e5e999359f..cd93944485 100644 --- a/pages/data-lab/how-to/create-data-lab.mdx +++ b/pages/data-lab/how-to/create-data-lab.mdx @@ -13,10 +13,12 @@ categories: - managed-services - data-lab --- +import Requirements from '@macros/iam/requirements.mdx' + Data Lab for Apache Spark™ is a product designed to assist data scientists and data engineers in performing calculations on a remotely managed Apache Spark infrastructure. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-lab/how-to/manage-delete-data-lab.mdx b/pages/data-lab/how-to/manage-delete-data-lab.mdx index 83570f9c5f..c4f21e0061 100644 --- a/pages/data-lab/how-to/manage-delete-data-lab.mdx +++ b/pages/data-lab/how-to/manage-delete-data-lab.mdx @@ -13,10 +13,12 @@ categories: - managed-services - data-lab --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage and delete your Data Lab for Apache Spark™. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-lab/quickstart.mdx b/pages/data-lab/quickstart.mdx index 831dd15a4c..6e12b90480 100644 --- a/pages/data-lab/quickstart.mdx +++ b/pages/data-lab/quickstart.mdx @@ -13,6 +13,8 @@ categories: - managed-services - data-lab --- +import Requirements from '@macros/iam/requirements.mdx' + Data Lab for Apache Spark™ is a product designed to assist data scientists and data engineers in performing calculations on a remotely managed Apache Spark infrastructure. @@ -26,7 +28,7 @@ Scaleway provides dedicated node types for both the notebook and the cluster. Th The notebook, although capable of performing some local computations, primarily serves as a web interface for interacting with the Apache Spark cluster. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-lab/troubleshooting/cannot-run-data-lab.mdx b/pages/data-lab/troubleshooting/cannot-run-data-lab.mdx index 314a6a44b2..2cb25b1758 100644 --- a/pages/data-lab/troubleshooting/cannot-run-data-lab.mdx +++ b/pages/data-lab/troubleshooting/cannot-run-data-lab.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-lab/troubleshooting/index.mdx b/pages/data-lab/troubleshooting/index.mdx index fd803ab9bc..35c8ccf1ec 100644 --- a/pages/data-lab/troubleshooting/index.mdx +++ b/pages/data-lab/troubleshooting/index.mdx @@ -20,7 +20,7 @@ productIcon: DistributedDataLabProductIcon ## Featured Pages - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/connect-bi-tools.mdx b/pages/data-warehouse/how-to/connect-bi-tools.mdx index 5b215ff639..7341c0908b 100644 --- a/pages/data-warehouse/how-to/connect-bi-tools.mdx +++ b/pages/data-warehouse/how-to/connect-bi-tools.mdx @@ -12,10 +12,12 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to integrate your Data Warehouse for ClickHouse® deployment with your preferred Business Intelligence (BI) tools. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/create-deployment.mdx b/pages/data-warehouse/how-to/create-deployment.mdx index 9b2a7e7b40..47c787b4f9 100644 --- a/pages/data-warehouse/how-to/create-deployment.mdx +++ b/pages/data-warehouse/how-to/create-deployment.mdx @@ -12,10 +12,12 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + A Data Warehouse is a centralized repository designed to store, manage, and analyze large volumes of structured and semi-structured data. When powered by ClickHouse®, it provides performance for real-time analytics and complex queries. This guide will walk you through the steps to deploy a Data Warehouse for ClickHouse® deployment using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/edit-autoscaling.mdx b/pages/data-warehouse/how-to/edit-autoscaling.mdx index a6b713b015..f6d2cb255b 100644 --- a/pages/data-warehouse/how-to/edit-autoscaling.mdx +++ b/pages/data-warehouse/how-to/edit-autoscaling.mdx @@ -12,10 +12,12 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to edit the autoscaling configuration of your Data Warehouse for ClickHouse® deployment using the [Scaleway console](https://console.scaleway.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/import-data.mdx b/pages/data-warehouse/how-to/import-data.mdx index 475ef6b1e3..3c93717a9a 100644 --- a/pages/data-warehouse/how-to/import-data.mdx +++ b/pages/data-warehouse/how-to/import-data.mdx @@ -12,12 +12,14 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + Data federation allows you to query and combine data from multiple sources, enabling seamless analytics across different databases or storage systems without the need to move or duplicate data. Scaleway Data Warehouse for ClickHouse® allows you to quickly import any type of compatible data into [bottomless storage](/data-warehouse/concepts/#bottomless-storage) with minimal configuration. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/manage-databases.mdx b/pages/data-warehouse/how-to/manage-databases.mdx index b01b638770..77052ad6f1 100644 --- a/pages/data-warehouse/how-to/manage-databases.mdx +++ b/pages/data-warehouse/how-to/manage-databases.mdx @@ -12,6 +12,8 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage databases in your Data Warehouse for ClickHouse® deployment using the [Scaleway console](https://console.scaleway.com/). @@ -19,7 +21,7 @@ This page explains how to manage databases in your Data Warehouse for ClickHouse During the private beta phase, database management can only be done with the **scwadmin** & via the ClickHouse® CLI, MySQL or HTTPS protocols. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/manage-delete-deployment.mdx b/pages/data-warehouse/how-to/manage-delete-deployment.mdx index fca098dbcc..3ec313c4db 100644 --- a/pages/data-warehouse/how-to/manage-delete-deployment.mdx +++ b/pages/data-warehouse/how-to/manage-delete-deployment.mdx @@ -12,10 +12,12 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage and delete your Data Warehouse deployment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/how-to/manage-users.mdx b/pages/data-warehouse/how-to/manage-users.mdx index 27a8a4013e..21846c276b 100644 --- a/pages/data-warehouse/how-to/manage-users.mdx +++ b/pages/data-warehouse/how-to/manage-users.mdx @@ -12,6 +12,8 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage users in your Data Warehouse for ClickHouse® deployment using the [Scaleway console](https://console.scaleway.com/). @@ -19,7 +21,7 @@ This page explains how to manage users in your Data Warehouse for ClickHouse® d During the private beta phase, user management can only be done with the **scwadmin** user via the ClickHouse® CLI, MySQL or HTTPS protocols. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/data-warehouse/quickstart.mdx b/pages/data-warehouse/quickstart.mdx index 380bb883d8..ed87d76c0b 100644 --- a/pages/data-warehouse/quickstart.mdx +++ b/pages/data-warehouse/quickstart.mdx @@ -12,10 +12,12 @@ dates: categories: - data-warehouse --- +import Requirements from '@macros/iam/requirements.mdx' + Data Warehouse for ClickHouse® is a centralized repository to store large sets of structured data, to streamline analysis and reporting for data science and business intelligence. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-account/how-to/accept-outsourcing.mdx b/pages/dedibox-account/how-to/accept-outsourcing.mdx index b5e6a57611..3aa2291fb3 100644 --- a/pages/dedibox-account/how-to/accept-outsourcing.mdx +++ b/pages/dedibox-account/how-to/accept-outsourcing.mdx @@ -12,19 +12,24 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-outsourcing-request.webp' +import image2 from './assets/scaleway-dedibox-console-outsourcing-accept.webp' + If you have a Scaleway Dedibox account, another user can grant you access to their dedicated servers and failover IPs by outsourcing them to you. This allows you to manage their services without gaining full access to their Dedibox account. - + - A Dedibox account logged into the [console](https://console.online.net) 1. When another user [sends you an outsourcing request](/dedibox-account/how-to/outsource-dedibox/), you will receive a notification. Click the link provided in the outsourcing request email to open the Scaleway Dedibox console. - + 2. The **Outsourcing** section of the Scaleway Dedibox console displays. 3. Review the services the user wants to outsource to you. 4. Check the **Accept** box for the service(s) you agree to take over. - + 5. Click **Save changes** to confirm. After completing these steps, the outsourced services will be available in your Dedibox console, and you can begin managing them. diff --git a/pages/dedibox-account/how-to/add-payment-method.mdx b/pages/dedibox-account/how-to/add-payment-method.mdx index 45b8289ce3..b5048cac61 100644 --- a/pages/dedibox-account/how-to/add-payment-method.mdx +++ b/pages/dedibox-account/how-to/add-payment-method.mdx @@ -12,8 +12,10 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-account/how-to/contact-support.mdx b/pages/dedibox-account/how-to/contact-support.mdx index 26d232edc5..24e9778fcf 100644 --- a/pages/dedibox-account/how-to/contact-support.mdx +++ b/pages/dedibox-account/how-to/contact-support.mdx @@ -12,8 +12,10 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-account/how-to/disable-two-factor-authentication.mdx b/pages/dedibox-account/how-to/disable-two-factor-authentication.mdx index bf6ff6dde0..16188e4626 100644 --- a/pages/dedibox-account/how-to/disable-two-factor-authentication.mdx +++ b/pages/dedibox-account/how-to/disable-two-factor-authentication.mdx @@ -12,6 +12,8 @@ dates: categories: - account --- +import image from './assets/scaleway-dedibox-console-security-menu.webp' + You can disable the multifactor authentication of your Dedibox account if you want to register a new authentication device. @@ -22,7 +24,7 @@ For security reasons, it is **not recommended to disable** multifactor authentic ## How to disable multifactor authentication 1. Click your username, next to _logged in as_, in the top right corner of the Dedibox console. Then click **Security** in the pop-up menu. - + 2. The security page displays. Click **Disable two factor authenticaton**. 3. Enter a security token generated by your multifactor authentication application and click **Confirm**. diff --git a/pages/dedibox-account/how-to/enable-two-factor-authentication.mdx b/pages/dedibox-account/how-to/enable-two-factor-authentication.mdx index b83d4e61e4..7856826a01 100644 --- a/pages/dedibox-account/how-to/enable-two-factor-authentication.mdx +++ b/pages/dedibox-account/how-to/enable-two-factor-authentication.mdx @@ -12,18 +12,23 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-security-menu.webp' +import image2 from './assets/scaleway-dedibox-console-2fa-activate.webp' + Multifactor authentication helps make your account safer. When enabled, after entering your password, a security code generated by your phone is required each time you log in. This authentication method ensures your account remains protected even in case of leaked passwords. - + - A Dedibox account logged into the [console](https://console.online.net) - Downloaded a multifactor authenticator application to your phone 1. Click your username, next to _logged in as_, in the top right corner of the Dedibox console. Then click **Security** in the pop-up menu. - + 2. The security page displays. Click **Show QR code** to display the QR code and add the Scaleway Dedibox console to your authenticator application. - + If your phone does not have a camera, you can manually enter the registration key shown in the console. diff --git a/pages/dedibox-account/how-to/manage-data-settings.mdx b/pages/dedibox-account/how-to/manage-data-settings.mdx index 12b8c8fc61..533edf3bba 100644 --- a/pages/dedibox-account/how-to/manage-data-settings.mdx +++ b/pages/dedibox-account/how-to/manage-data-settings.mdx @@ -12,10 +12,12 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + You can manage your data privacy settings from the Scaleway Dedibox console. - + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-account/how-to/outsource-dedibox.mdx b/pages/dedibox-account/how-to/outsource-dedibox.mdx index b7b17f537c..6cbe15bb11 100644 --- a/pages/dedibox-account/how-to/outsource-dedibox.mdx +++ b/pages/dedibox-account/how-to/outsource-dedibox.mdx @@ -12,12 +12,16 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-dedibox-outsourcing.webp' + Outsourcing a Dedibox dedicated server means entrusting the technical management of your machines and services to another Scaleway Dedibox account while retaining control over your main account. By outsourcing your servers, you grant permission to a third party to handle management on your behalf. This allows the designated Dedibox account holder access to all the necessary technical details of your Dedibox. However, they will not be able to view your billing information or make any changes to the services within your primary account. This ensures you maintain full control over your billing and service configurations while benefiting from external technical expertise. - + - A Dedibox account logged into the [console](https://console.online.net) - At least one Dedibox server @@ -31,7 +35,7 @@ By outsourcing your servers, you grant permission to a third party to handle man 1. In the top menu, click **Server** > **Server list** to display the list of your servers. 2. Select the server you want to outsource and click **Manage** to view its details. 3. Click **Outsourcing** in the side menu of your server's status page: - + The outsourcing form displays 4. Enter the identifier of the new technical contact for your server. The identifier is the login of the other user's console account. Click **Send request** to validate the form. diff --git a/pages/dedibox-account/how-to/recover-password-lost-email.mdx b/pages/dedibox-account/how-to/recover-password-lost-email.mdx index 49c5be5d1b..63f697579b 100644 --- a/pages/dedibox-account/how-to/recover-password-lost-email.mdx +++ b/pages/dedibox-account/how-to/recover-password-lost-email.mdx @@ -12,13 +12,15 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + To ensure the security of your Scaleway Dedibox account, it is strongly advised that you regularly verify and update your contact details, especially your email address. This precaution helps prevent potential account lockouts if you lose access to both your console password and email account. In the unlikely event that you encounter such a situation, follow these steps to recover access to your Scaleway Dedibox account. - + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-account/how-to/report-incident.mdx b/pages/dedibox-account/how-to/report-incident.mdx index 1e6348d921..36a58091ba 100644 --- a/pages/dedibox-account/how-to/report-incident.mdx +++ b/pages/dedibox-account/how-to/report-incident.mdx @@ -12,8 +12,10 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/pages/dedibox-account/how-to/resolve-abuse.mdx b/pages/dedibox-account/how-to/resolve-abuse.mdx index 250d351023..ad62eff2a9 100644 --- a/pages/dedibox-account/how-to/resolve-abuse.mdx +++ b/pages/dedibox-account/how-to/resolve-abuse.mdx @@ -12,6 +12,8 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + Abuse reports are complaints regarding the use of Scaleway services for illegal behavior or hosting of illegal content. Abuse reports for the same issue on the same resource within a given time frame are grouped by case. @@ -22,7 +24,7 @@ However, Scaleway reserves the right to immediately suspend the infringing servi If you encounter any issue with the resolution of an abuse, ensure that you contact the abuse team by opening a [support ticket](https://console.scaleway.com/support/tickets/create) directly from your console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -67,7 +69,7 @@ However, Scaleway reserves the right to immediately suspend the infringing servi If you encounter any issue with the resolution of your abuse tickets, please contact the abuse team by opening a [support ticket](https://console.scaleway.com/support/tickets/create) directly from your console. - + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-account/how-to/revoke-outsourcing.mdx b/pages/dedibox-account/how-to/revoke-outsourcing.mdx index 1779c0358a..a73bdeda1e 100644 --- a/pages/dedibox-account/how-to/revoke-outsourcing.mdx +++ b/pages/dedibox-account/how-to/revoke-outsourcing.mdx @@ -12,10 +12,14 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-outsourcing-revoke.webp' + Outsourced services refer to services managed by a different technical contact than the owner of the service. This technical contact, who is another Scaleway Dedibox account holder, can manage these services without requiring full access to the owner's Scaleway Dedibox account. - + - A Dedibox account logged into the [console](https://console.online.net) @@ -24,7 +28,7 @@ Outsourced services refer to services managed by a different technical contact t 1. Log in to the [Dedibox console](https://console.online.net). 2. Click your username next to _logged in as_ in the top right corner of the Dedibox console. Then select **Outsourcing** from the pop-up menu. 3. On the outsourcing page, navigate to the **Outsourced** tab to view a list of your outsourced services. Select the checkbox next to each service you want to revoke the outsourcing for: - + 4. Click **Remove selected roles** to confirm and initiate the revocation of outsourcing for the selected services. Once you complete these steps, the services will no longer be associated with the outsourced account, and the technical management will revert to the owner of the service. diff --git a/pages/dedibox-account/how-to/update-email.mdx b/pages/dedibox-account/how-to/update-email.mdx index 03c128d58a..ee0f3ae2ad 100644 --- a/pages/dedibox-account/how-to/update-email.mdx +++ b/pages/dedibox-account/how-to/update-email.mdx @@ -12,22 +12,27 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-update-email.webp' +import image2 from './assets/scaleway-dedibox-console-confirm-new-email.webp' + Every Scaleway Dedibox account is associated with a specific email address. In the event that your email address undergoes any changes, you have the option to update this information directly within your account settings. - + - A Dedibox account logged into the [console](https://console.online.net) ## How to update your email address 1. Click your username, next to **_logged in as_**, in the top right corner of the Dedibox console. Then click **Account information** in the pop-up menu. The account information page displays. 2. Click **Update** next to your email address: - + A link will be sent to the email address registered in the account. 3. Click the link sent to your registered email address, to access the email update form. 4. Enter your new email address and its confirmation. Then click **Update my mail** to submit. - + You have now linked your new email address to your Scaleway Dedibox account. diff --git a/pages/dedibox-account/how-to/update-password.mdx b/pages/dedibox-account/how-to/update-password.mdx index 37193376e3..25514edbbc 100644 --- a/pages/dedibox-account/how-to/update-password.mdx +++ b/pages/dedibox-account/how-to/update-password.mdx @@ -12,16 +12,20 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-update-password.webp' + For security reasons, we recommend changing your passwords regularly. You can update your Dedibox password anytime from the [Scaleway Dedibox console](https://console.online.net/). - + - A Dedibox account logged into the [console](https://console.online.net) 1. Click your username, next to _logged in as_, in the top right corner of the Dedibox console. Then click **Account information** in the pop-up menu. The account information page displays. 2. Click **Update** next to your (hidden) password: - + 3. Click the link sent to your registered email address to access the update form. 4. Enter your current password, your new password, and its confirmation. Click **Update my password** to submit the form. diff --git a/pages/dedibox-account/how-to/upload-an-ssh-key.mdx b/pages/dedibox-account/how-to/upload-an-ssh-key.mdx index 8846537ae7..5706c0af5a 100644 --- a/pages/dedibox-account/how-to/upload-an-ssh-key.mdx +++ b/pages/dedibox-account/how-to/upload-an-ssh-key.mdx @@ -12,15 +12,19 @@ dates: categories: - account --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-console-ssh-key-menu.webp' + SSH keys offer a more secure method of identity authentication on computer systems compared to passwords. Each SSH key comprises a private and a public part, which can be generated on your computer. The public part serves the purpose of passwordless authentication and can be uploaded to the Scaleway Dedibox console and then transferred to your dedicated server during installation. - + - A Dedibox account logged into the [console](https://console.online.net) 1. In the top right corner of the Dedibox console, click on your username to open the pop-up menu. From there, select **SSH keys**. - + You will be taken to a page displaying all your existing SSH keys (if you have not created any key yet, the list will be empty). 2. Click **Add SSH key** to open the SSH key form. 3. Provide a description of your choice (e.g., your computer's name) and paste the public key into the designated field. diff --git a/pages/dedibox-dns/how-to/add-dns-delegation.mdx b/pages/dedibox-dns/how-to/add-dns-delegation.mdx index 1edbf8c2d5..38d9eb2027 100644 --- a/pages/dedibox-dns/how-to/add-dns-delegation.mdx +++ b/pages/dedibox-dns/how-to/add-dns-delegation.mdx @@ -12,11 +12,16 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-server-list.webp' +import image2 from './assets/scaleway-edit-delegation.webp' + You cannot edit the reverse of IPv4 /27 blocks nor the IPv6 blocks (/48 - /56 - /64) directly in the console. Therefore, you will have to delegate your subnet to your nameservers. This will delegate the task of propagating the DNS reverses of your IPs on the internet to your servers. You will need two DNS servers for redundancy and can delegate the subnets directly to your account. - + - A Dedibox account logged into the [console](https://console.online.net) - Created a corresponding **A record** for your reverse DNS at least 24 hours ago @@ -24,9 +29,9 @@ This will delegate the task of propagating the DNS reverses of your IPs on the i ## How to add a DNS delegation in the console 1. From the [console](https://console.online.net), click **Server** in the top menu, then select **Network configuration**. - + 2. Click the settings icon (cogwheel) next to the relevant IP block, then select **Edit nameserver delegation**. The **Edit nameserver delegation** page displays. - + 3. Enter details for the two name servers, and click **Update delegation**. - You can have a minimum of two and a maximum of five name servers. To add more name servers, use the **Add nameserver** button. diff --git a/pages/dedibox-dns/how-to/configure-reverse-dns.mdx b/pages/dedibox-dns/how-to/configure-reverse-dns.mdx index e80d896d5a..35569882d5 100644 --- a/pages/dedibox-dns/how-to/configure-reverse-dns.mdx +++ b/pages/dedibox-dns/how-to/configure-reverse-dns.mdx @@ -12,21 +12,27 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-server-list.webp' +import image2 from './assets/scaleway-edit-reverse-button.webp' +import image3 from './assets/scaleway-edit-reverse-panel.webp' + Reverse DNS is the opposite of classic "forward" DNS, and maps an IP address to a hostname. This can be useful if, for example, you want to send emails from your server. If you are using the default reverse (`*.poneytelecom.eu`), you may experience problems with deliverability of your mails and during the subscription of certain tools like [JMRP](https://postmaster.live.com/snds/JMRP.aspx). - + - A Dedibox account logged into the [console](https://console.online.net) - Created a corresponding **A record** for your reverse DNS at least 24 hours ago 1. From the [console](https://console.online.net), click **Server** in the top menu, then select **Server list**. - + 2. Click **Manage** next to the relevant server. 3. Under **Network**, click **Edit Reverses**. - + 4. Enter the new reverse DNS of your IP (generally this corresponds to your hostname) and click **Update**. - + Your reverse DNS is now updated. diff --git a/pages/dedibox-dns/how-to/configure-secondary-dns.mdx b/pages/dedibox-dns/how-to/configure-secondary-dns.mdx index 1d624c56f5..e7ecb5e23a 100644 --- a/pages/dedibox-dns/how-to/configure-secondary-dns.mdx +++ b/pages/dedibox-dns/how-to/configure-secondary-dns.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + Secondary DNS allows you to have your domain's zone file automatically backed up on a second set of name servers. This backup is a read-only copy of the zone file, containing the DNS records. @@ -21,7 +23,7 @@ This how-to assumes that you want to manage your domains exclusively with BIND. Be aware that there is a delay of 24 hours upon completing this procedure before it takes effect. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) diff --git a/pages/dedibox-domains/how-to/change-ownership.mdx b/pages/dedibox-domains/how-to/change-ownership.mdx index 910bbe466a..e1bca20624 100644 --- a/pages/dedibox-domains/how-to/change-ownership.mdx +++ b/pages/dedibox-domains/how-to/change-ownership.mdx @@ -9,6 +9,11 @@ dates: validation: 2025-02-24 posted: 2021-05-26 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-trade-domain.webp' +import image2 from './assets/scaleway-trade-domain-2.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -20,7 +25,7 @@ You must always keep the contact details relating to the owner of your domain na Before changing the ownership of the domain, you must [ensure that all contact email addresses of the domain are up to date](#how-to-check-and-update-the-contact-email). - + - A Dedibox account logged into the [console](https://console.online.net) - A Scaleway domain you want to transfer to a new owner, who must have [created a Dedibox account](/dedibox-account/how-to/create-a-dedibox-account/) @@ -38,11 +43,11 @@ Before changing the ownership of the domain, you must [ensure that all contact e 1. From the console, click **Domain** at the top right of the screen. 2. Click **Trades**. Trading is the procedure that allows you to change the ownership of a domain. - + 3. Click **Initiate a domain trade**. 4. Select the relevant domain name and click **Order**. 5. Select the account of the new owner, searching for it via the account login if necessary, and click **Confirm**. - + 6. Create a handle for the new owner, including all their contact details, and click **Confirm**. 7. Confirm the ownership trade and pay the administrative fee. 8. For the extensions `.fr`, `.eu`, and `.be`, emails will be sent to both the old and new owners of the domain. Both parties are required to validate the trade by clicking the enclosed link. Without this action, the change of ownership will not be validated. diff --git a/pages/dedibox-domains/how-to/enable-dnssec.mdx b/pages/dedibox-domains/how-to/enable-dnssec.mdx index bc8f32284d..3c4fbb0370 100644 --- a/pages/dedibox-domains/how-to/enable-dnssec.mdx +++ b/pages/dedibox-domains/how-to/enable-dnssec.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-configure.webp' +import image2 from './assets/scaleway-activate-dnssec-ext.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -36,7 +41,7 @@ DNSSEC should only be used by experienced users, due to the propagation time of This page shows you how to enable DNSSEC for **Online.net domains only**. Find out how to enable DNSSEC for Domains and DNS domains via [the API](https://www.scaleway.com/en/developers/api/domains-and-dns/registrar-api/#path-domains-update-domain-dnssec) or the [Scaleway console](/domains-and-dns/how-to/configure-dnssec-internal-domain/). - + - A Dedibox account logged in to the [Online console](https://console.online.net) - An Online domain name @@ -47,7 +52,7 @@ Although DNSSEC should generally only be configured by experienced users, this s 1. Log in to the [Online console](https://console.online.net). 2. Click **Domain**. A list of your domains displays. - + 3. Click **Configure domain name** next to the relevant domain. 4. Click the **Activate DNSSEC** button to activate DNSSEC, if allowed by your domain extension. If DNSSEC is already activated, the **Deactivate DNSSEC** button displays, allowing you to deactivate it if you wish. @@ -60,7 +65,7 @@ Although DNSSEC should generally only be configured by experienced users, this s 2. Click **Domain**. A list of your domains displays. 3. Click **Configure domain name** next to the relevant domain. 4. Click the **Manage DNSSEC** tab. - + 5. Depending on whether you want to activate or deactivate DNSSEC: - **Activation**: A key is generated for you. Complete the rest of the configuration fields, and click **Update DNS Records** to transfer them to the registrar. In case of error, you can modify this information at a later date. - **Deactivation**: Click **Delete DNS Records** to request deletion from the registry. You will then need to delete the records from the DNS server yourself. diff --git a/pages/dedibox-domains/how-to/file-contact-info.mdx b/pages/dedibox-domains/how-to/file-contact-info.mdx index f545b55cbc..3d7cba9792 100644 --- a/pages/dedibox-domains/how-to/file-contact-info.mdx +++ b/pages/dedibox-domains/how-to/file-contact-info.mdx @@ -12,6 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-handles.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -23,14 +27,14 @@ You must always ensure that the contact information for the domain owner is accu If you wish to change details about the owner’s identity, such as full name(s) or corporate name, you must complete the [change of owner/applicant](/dedibox-domains/how-to/change-ownership/) process via the [console](https://console.online.net/fr/domain/trade). - + - A Dedibox account logged into the [console](https://console.online.net) - A domain registered with Scaleway 1. From the [Dedibox console](https://console.online.net), click **Domain**. A list of your domains displays. 2. Click the **Domain handles** tab. A list of all your handles and their associated domains displays. - + 3. Click **Edit** next to the handle whose contact details you wish to edit. 4. Check and update the contact details as necessary, then click **Update handle data** at the bottom of the page. diff --git a/pages/dedibox-domains/how-to/manage-dns-servers.mdx b/pages/dedibox-domains/how-to/manage-dns-servers.mdx index f10046590d..27e030d5a7 100644 --- a/pages/dedibox-domains/how-to/manage-dns-servers.mdx +++ b/pages/dedibox-domains/how-to/manage-dns-servers.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-configure.webp' +import image2 from './assets/scaleway-change-dns.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -24,7 +29,7 @@ Scaleway Dedibox's DNS servers are as follows: * Primary server: ns0.online.net (`195.154.228.249`) * Secondary server: ns1.online.net (`62.210.16.9`) - + - A Dedibox account logged into the [console](https://console.online.net) - A domain name @@ -73,9 +78,9 @@ For email: 1. From the [Dedibox console](https://console.online.net), click **Domain**. A list of your domains displays. 2. Click **Configure domain name** next to the relevant domain. - + 3. Click the **Manage DNS servers** tab. - + 4. Modify the DNS servers to your requirements. The DNS zone must be configured on the new server before the change in the console. diff --git a/pages/dedibox-domains/how-to/manage-dns-zones.mdx b/pages/dedibox-domains/how-to/manage-dns-zones.mdx index 9bdd27329f..e4450319af 100644 --- a/pages/dedibox-domains/how-to/manage-dns-zones.mdx +++ b/pages/dedibox-domains/how-to/manage-dns-zones.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-configure.webp' +import image2 from './assets/scaleway-edit-dns-zone.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -23,7 +28,7 @@ For example, **A** records indicate where to find the website and **MX** records This document shows you how to manage your domain's DNS zones. - + - A Dedibox account logged into the [console](https://console.online.net) - A domain name @@ -55,9 +60,9 @@ Each modification on an existing DNS zone will launch the creation of a new temp 1. From the [Dedibox console](https://console.online.net), click **Domain**. A list of your domains displays. 2. Click **Configure domain name** next to the relevant domain. - + 3. Click the **Edit DNS zone** tab. - + 4. Note the following parts of the interface: - At the top of the screen, the **Select a zone version** drop-down menu lets you navigate between your different zone versions to modify them and set them as active. - The pen icon next to the zone name in the **Active Version** panel lets you manage the zone's options. Click the pen to edit the zone name or set it as active. diff --git a/pages/dedibox-domains/how-to/purchase-domain.mdx b/pages/dedibox-domains/how-to/purchase-domain.mdx index e441c92baf..6e19acfeac 100644 --- a/pages/dedibox-domains/how-to/purchase-domain.mdx +++ b/pages/dedibox-domains/how-to/purchase-domain.mdx @@ -12,6 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-order-domain.webp' +import image2 from './assets/scaleway-order-domain-contact.webp' +import image3 from './assets/scaleway-order-domain-summary.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -19,12 +25,12 @@ categories: A domain name is the equivalent of your postal address on the web, and allows your users to find your website. Scaleway offers you the possibility of buying a domain name with or without web hosting. Depending on availability, you can buy the domain name and extension (.com, .fr, .net etc.) of your choice. - + - A Dedibox account logged into the [console](https://console.online.net) 1. In your browser, navigate to [the domain name order page](https://www.scaleway.com/en/domain/). - + 2. Enter the domain name of your choice in the search bar and click **search a domain**. The **Domain name choice** page displays, showing whether the domain is available and for which extensions. If the domain name is not available because you are already the owner, you have the option to transfer the domain so that Scaleway becomes your new registrar, and you can manage your hosting and domain from the same location. See the [relevant documentation](/dedibox-domains/how-to/transfer-domain/) for more information. @@ -41,7 +47,7 @@ A domain name is the equivalent of your postal address on the web, and allows yo 6. Scroll down to the bottom of the page and click **Order**. 7. If you did not select hosting backup, a pop-up may display asking you to confirm your choice. Click **Continue without backup** or **Add backup**. The **Contact information** page displays. 8. Select the domain owner from your existing contacts, or choose to create a new contact. - + You must always keep the contact details relating to the owner of your domain name accurate and up-to-date. Once created, if you wish to change details about the owner’s identity, such as full name(s) or corporate name, you must complete the [change of owner/applicant](/dedibox-domains/how-to/change-ownership/) process via the [console](https://console.online.net/fr/domain/trade). @@ -50,7 +56,7 @@ A domain name is the equivalent of your postal address on the web, and allows yo If you chose to create a new contact, you will be required to enter their details. Do so, and click **Create Handle**. Once completed, the **Summary** page displays. 10. Check the summary of your order and select a payment mode from the drop-down menu. You must also agree to the terms of service and web hosting specific terms, and choose whether to activate automatic renewal of your domain. - + 11. Scroll down to the bottom of the page and click **Confirm my command**. You are redirected to the payment gateway to complete your payment. diff --git a/pages/dedibox-domains/how-to/renew-domain.mdx b/pages/dedibox-domains/how-to/renew-domain.mdx index b6188e3af7..8c0bb0bd5f 100644 --- a/pages/dedibox-domains/how-to/renew-domain.mdx +++ b/pages/dedibox-domains/how-to/renew-domain.mdx @@ -12,6 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-renew-domain.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -19,13 +23,13 @@ categories: When you buy a domain name, you can use it for the period of time you registered it for, which is typically from one to ten years. When this period is nearing its end, you must renew your domain if you wish to keep using it. - + - A Dedibox account logged into the [console](https://console.online.net) - A domain registered with Scaleway 1. In your browser, navigate to [the domain name renewal page](https://console.online.net/en/order/renew). A list of your hosting packages and domain names displays. - + 2. Select the domain name you want to renew, select a renewal period, and click **Renew**. You are directed to the Summary page. 3. Check the summary of your renewal order and select your payment mode from the drop-down list. Agree to the terms and conditions, and click **Confirm my order**. diff --git a/pages/dedibox-domains/how-to/transfer-domain.mdx b/pages/dedibox-domains/how-to/transfer-domain.mdx index 6a3e3eb28f..08fce2cc71 100644 --- a/pages/dedibox-domains/how-to/transfer-domain.mdx +++ b/pages/dedibox-domains/how-to/transfer-domain.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-transfer-domain.webp' +import image2 from './assets/scaleway-authcode.webp' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -19,7 +24,7 @@ categories: You can transfer any domain bought or renewed at another registrar to Scaleway as long as you meet the conditions shown below. - + - A Dedibox account logged into the [console](https://console.online.net) - An unlocked domain at an external registrar (not Scaleway) and access to its authorization key @@ -32,9 +37,9 @@ You can transfer any domain bought or renewed at another registrar to Scaleway a 1. In your browser, navigate to [the Scaleway domain name order page](https://www.scaleway.com/en/domain/). 2. Enter your domain name in the search bar, and click **search a domain**. The **Domain name choice** page displays, showing that the domain is not available for buy. - + 3. Scroll to the **Are you the owner of this domain name?** section, and under **Transfer**, click **Transfer yourdomain.ext**. You are directed to the transfer form. - + 4. Enter the Authcode provided by your current registrar (if it is required: this depends on the domain extension). By default, Scaleway's DNS servers are not activated after the transfer. However, you can choose to activate these by ticking the box if you wish. diff --git a/pages/dedibox-domains/how-to/validate-waps-info.mdx b/pages/dedibox-domains/how-to/validate-waps-info.mdx index 5892a1dcff..0616aa8797 100644 --- a/pages/dedibox-domains/how-to/validate-waps-info.mdx +++ b/pages/dedibox-domains/how-to/validate-waps-info.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -21,7 +23,7 @@ WAPS, or **W**hois **A**ccuracy **P**rogram **S**pecification, is a system intro Domain owners are responsible for the use of their domain. - + - A Dedibox account logged into the [console](https://console.online.net) - A domain registered with Scaleway diff --git a/pages/dedibox-domains/quickstart.mdx b/pages/dedibox-domains/quickstart.mdx index 2ccbb9c184..f5352ae5d8 100644 --- a/pages/dedibox-domains/quickstart.mdx +++ b/pages/dedibox-domains/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation applies to the legacy domain product previously offered by Online.net. For managing your domain names with the latest features, we recommend using Scaleway's [Domains and DNS](/domains-and-dns/quickstart/) service. @@ -19,7 +21,7 @@ categories: A domain name is the equivalent of your postal address on the web, and allows your users to find your website. Scaleway offers you the possibility of purchasing a domain name with or without web hosting. Depending on availability, you can buy the domain name and extension (`.com`, `.fr`, `.net`, etc.) of your choice. - + - A Dedibox account logged into the [console](https://console.online.net) diff --git a/pages/dedibox-hardware/how-to/configure-dell-perc-h200.mdx b/pages/dedibox-hardware/how-to/configure-dell-perc-h200.mdx index aafd940673..ee63c11a04 100644 --- a/pages/dedibox-hardware/how-to/configure-dell-perc-h200.mdx +++ b/pages/dedibox-hardware/how-to/configure-dell-perc-h200.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation explains how to configure the DELL PERC H200 RAID controller on a Scaleway Dedibox. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with a [DELL PERC H200](https://www.dell.com/support/kbdoc/en-us/000134280/perc-dell-perc-h200-and-6gbps-sas-hba-features) RAID controller diff --git a/pages/dedibox-hardware/how-to/configure-dell-perc-h310-h700-h710-h730p-lsi9361.mdx b/pages/dedibox-hardware/how-to/configure-dell-perc-h310-h700-h710-h730p-lsi9361.mdx index 473fca6f15..1feb520fc0 100644 --- a/pages/dedibox-hardware/how-to/configure-dell-perc-h310-h700-h710-h730p-lsi9361.mdx +++ b/pages/dedibox-hardware/how-to/configure-dell-perc-h310-h700-h710-h730p-lsi9361.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to configure the DELL PERC H310 / H700 / H710 / H730-P / LSI9361 RAID controller on a Scaleway Dedibox. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with a H310 / H700 / H710 / H730-P / LSI9361 RAID controller diff --git a/pages/dedibox-hardware/how-to/configure-hardware-raid-console.mdx b/pages/dedibox-hardware/how-to/configure-hardware-raid-console.mdx index 5138df45fd..93dac85068 100644 --- a/pages/dedibox-hardware/how-to/configure-hardware-raid-console.mdx +++ b/pages/dedibox-hardware/how-to/configure-hardware-raid-console.mdx @@ -12,12 +12,14 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + A hardware RAID is a type of [RAID](/dedibox-hardware/concepts/#raid) implementation where construction and management of the RAID is performed on dedicated hardware, independently of the operating system. The logical disks of the RAID array are managed by a physical controller, sitting on the PCI bus, which presents only the logical volumes to the operating system. The RAID controller manages the RAID using its own CPU and RAM, without delegating tasks to the main CPU of the machine. - + - A [Dedibox account](https://console.online.net) - A Dedibox server with hardware RAID controller diff --git a/pages/dedibox-hardware/how-to/configure-hp-smart-array.mdx b/pages/dedibox-hardware/how-to/configure-hp-smart-array.mdx index d887493572..800ac1ab09 100644 --- a/pages/dedibox-hardware/how-to/configure-hp-smart-array.mdx +++ b/pages/dedibox-hardware/how-to/configure-hp-smart-array.mdx @@ -12,8 +12,10 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with an HP Smart Array P222, P410 or P420 RAID controller diff --git a/pages/dedibox-hardware/how-to/configure-raid-kvm-h200.mdx b/pages/dedibox-hardware/how-to/configure-raid-kvm-h200.mdx index 0c653bf043..e2ca9af0c0 100644 --- a/pages/dedibox-hardware/how-to/configure-raid-kvm-h200.mdx +++ b/pages/dedibox-hardware/how-to/configure-raid-kvm-h200.mdx @@ -12,8 +12,16 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway_h200_enter_config.webp' +import image2 from './assets/scaleway_h200_01.webp' +import image3 from './assets/scaleway_h200_03.webp' +import image4 from './assets/scaleway_h200_05.webp' +import image5 from './assets/scaleway_h200_06.webp' + + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with a [DELL PERC H200](https://www.dell.com/support/kbdoc/en-us/000134280/perc-dell-perc-h200-and-6gbps-sas-hba-features) RAID controller @@ -25,19 +33,19 @@ categories: Set your Java security settings to **low** to avoid connection problems. 4. Press **CTRL** + **C** during the boot process to enter the RAID configuration utility: - + 5. The RAID configuration utility main screen displays. Select the RAID controller to configure and press Enter. - + 6. Select **RAID Properties** and press enter. The RAID configuration displays. Select **Manage volume** and press **Enter**. - + 7. Create a new volume and select the RAID type for the volume: - + By creating a new RAID volume **all data** on volume disks will be **deleted**. 8. Select the drives for the volume and save your settings: - + Select a disk using the arrow keys on your keyboard. You can change **NO** to **YES** by pressing the spacebar. diff --git a/pages/dedibox-hardware/how-to/configure-raid-kvm-h310.mdx b/pages/dedibox-hardware/how-to/configure-raid-kvm-h310.mdx index 984aec3313..1ff5c3f823 100644 --- a/pages/dedibox-hardware/how-to/configure-raid-kvm-h310.mdx +++ b/pages/dedibox-hardware/how-to/configure-raid-kvm-h310.mdx @@ -12,8 +12,17 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_h310_01.webp' +import image2 from './assets/scaleway_h310_02.webp' +import image3 from './assets/scaleway_h310_03.webp' +import image4 from './assets/scaleway_h310_04.webp' +import image5 from './assets/scaleway_h310_05.webp' +import image6 from './assets/scaleway_h310_06.webp' + The personalized RAID configuration allows you to create a RAID mode that cannot be created via the management console of Online.net (RAID10, for example). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with a DELL PERC H310 / H700 / H710 / H730-P / LSI9361 RAID controller 1. Click **Server** > **Server list** to display the list of your servers. Click the identifier of the server you want to configure. The server information page displays. @@ -25,14 +34,14 @@ The personalized RAID configuration allows you to create a RAID mode that cannot Once the server's screen output is visible in the KVM applet, reboot the machine. 4. Press **CTRL** + **C** during the boot process to enter the RAID configuration utility: - + 5. The RAID configuration tool's main interface displays. Select the virtual disk to delete: - + 6. Press **F2**, then select **Delete VD** and press enter to delete the virtual disk: - + 7. Create a new virtual disk by selecting **No configuration present**. The following screen displays, allowing you to configure a new virtual disk: - + 8. Return to the main menu and select the virtual disk. Then press **F2**, and select **Fast Init.** and press enter to initialize the virtual disk: - + 7. Press **OK** once the initialization is completed on the virtual drive. Then press **Strg** + **ALT** + **CTRL** to reboot the machine: - \ No newline at end of file + \ No newline at end of file diff --git a/pages/dedibox-hardware/how-to/configure-raid-kvm-p410.mdx b/pages/dedibox-hardware/how-to/configure-raid-kvm-p410.mdx index a8a6188fb9..3a207dfa8d 100644 --- a/pages/dedibox-hardware/how-to/configure-raid-kvm-p410.mdx +++ b/pages/dedibox-hardware/how-to/configure-raid-kvm-p410.mdx @@ -12,10 +12,17 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_p410_01.webp' +import image2 from './assets/scaleway_p410_02.webp' +import image3 from './assets/scaleway_p410_03.webp' +import image4 from './assets/scaleway_p410_04.webp' + The personalized RAID configuration allows you to create a RAID mode that cannot be created via the management console of Online.net (RAID10, for example). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with an HP Smart Array P410 RAID controller @@ -27,16 +34,16 @@ The personalized RAID configuration allows you to create a RAID mode that cannot Set your Java security settings to **low** to avoid connection problems. 4. Press **F8** during the boot process to enter the RAID configuration utility: - + 5. Select **Delete Logical Drive** with the error keys and press **Enter** to select. - + 6. Press **F3** to confirm the deletion of the local drive: - + This will result in complete data loss for this logical drive. 7. Select **Create Logical Drive** in the main menu. Then use the **Tab** key on your keyboard to navigate and configure your RAID: - + diff --git a/pages/dedibox-hardware/how-to/configure-raid-kvm-p420.mdx b/pages/dedibox-hardware/how-to/configure-raid-kvm-p420.mdx index 4640034bfd..a77b40b4f4 100644 --- a/pages/dedibox-hardware/how-to/configure-raid-kvm-p420.mdx +++ b/pages/dedibox-hardware/how-to/configure-raid-kvm-p420.mdx @@ -12,10 +12,19 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_p420_01.webp' +import image2 from './assets/scaleway_p420_03.webp' +import image3 from './assets/scaleway_p420_04.webp' +import image4 from './assets/scaleway_p420_05.webp' +import image5 from './assets/scaleway_p420_07.webp' +import image6 from './assets/scaleway_p420_08.webp' + The personalized RAID configuration allows you to create a RAID mode that cannot be created via the management console of Online.net (RAID10, for example). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) with an HP Smart Array P420 RAID controller @@ -27,21 +36,21 @@ The personalized RAID configuration allows you to create a RAID mode that cannot Set your Java security settings to **low** to avoid connection problems. 4. Press **F8** during the boot process to enter the RAID configuration utility: - + 5. Select the RAID controller from the drop-down menu. The current array configuration displays: - + 6. Click **Delete** to delete the existing virtual disk. A pop-up displays. Click **OK** to confirm deletion of the logical drive: - + Deleting your logical drive will erase all data stored on it. 7. Create a new logical array once the previous one is deleted. To do so, click **Create Array**: - + 8. Select the physical disks you want to use for the virtual device and confirm by clicking **OK**: - + 9. Select the parameters for the array and click **Save** to write the changes to the disks: - + 10. Click **Exit ACU** to quit the array configuration and reboot your server. diff --git a/pages/dedibox-hardware/troubleshooting/diagnose-defective-disk.mdx b/pages/dedibox-hardware/troubleshooting/diagnose-defective-disk.mdx index 0ed5245f6d..7a82786221 100644 --- a/pages/dedibox-hardware/troubleshooting/diagnose-defective-disk.mdx +++ b/pages/dedibox-hardware/troubleshooting/diagnose-defective-disk.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-hardware --- +import Requirements from '@macros/iam/requirements.mdx' + `Smartmontools` is a set of tools that controls and monitors a disk using the **SMART** standard (Self-Monitoring, Analysis, and Reporting Technology System). @@ -22,7 +24,7 @@ It consists of two parts: The tool supports the vast majority of modern hard drives. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox/) diff --git a/pages/dedibox-hardware/troubleshooting/index.mdx b/pages/dedibox-hardware/troubleshooting/index.mdx index e0e6c6bfa0..1e10fcdb3c 100644 --- a/pages/dedibox-hardware/troubleshooting/index.mdx +++ b/pages/dedibox-hardware/troubleshooting/index.mdx @@ -20,13 +20,13 @@ productIcon: DediboxProductIcon ## Featured Pages - - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server - + 1. Click **Server** in your Dedibox console to display a list of your dedicated servers. Then click on the server you want to configure. 2. On the server's status page, click **Failover** in the menu on the left. diff --git a/pages/dedibox-ip-failover/how-to/configure-centos.mdx b/pages/dedibox-ip-failover/how-to/configure-centos.mdx index 557a5af882..d751a55cf8 100644 --- a/pages/dedibox-ip-failover/how-to/configure-centos.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-centos.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-ip-failover --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure a [failover IP](/dedibox-ip-failover/concepts/#failover-ips) on Dedibox servers running on CentOS. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server diff --git a/pages/dedibox-ip-failover/how-to/configure-debian-ubuntu.mdx b/pages/dedibox-ip-failover/how-to/configure-debian-ubuntu.mdx index 6521f31cce..5ec8fecc16 100644 --- a/pages/dedibox-ip-failover/how-to/configure-debian-ubuntu.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-debian-ubuntu.mdx @@ -12,12 +12,14 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + This guide provides step-by-step instructions for configuring a Dedibox [failover IP](/dedibox-ip-failover/concepts/#failover-ips) on Debian and Ubuntu Linux. A failover IP is a secondary IP address that can be assigned to your server. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server diff --git a/pages/dedibox-ip-failover/how-to/configure-freebsd.mdx b/pages/dedibox-ip-failover/how-to/configure-freebsd.mdx index 00c8aef6e7..5e834dc357 100644 --- a/pages/dedibox-ip-failover/how-to/configure-freebsd.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-freebsd.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure a [failover IP](/dedibox-ip-failover/concepts/#failover-ips) on Dedibox servers running on FreeBSD. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server diff --git a/pages/dedibox-ip-failover/how-to/configure-multiip-virtualmac.mdx b/pages/dedibox-ip-failover/how-to/configure-multiip-virtualmac.mdx index 8b28d2abf9..02818f7440 100644 --- a/pages/dedibox-ip-failover/how-to/configure-multiip-virtualmac.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-multiip-virtualmac.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + You can use the same virtual MAC at several failover IPs pointing on the same dedicated server. @@ -19,7 +21,7 @@ To do this, you need to have several [failover IPs](/dedibox-ip-failover/concept As long as they share the same virtual MAC, your failover IPs must be moved in a group from one server to another. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server diff --git a/pages/dedibox-ip-failover/how-to/configure-network-virtual-machine.mdx b/pages/dedibox-ip-failover/how-to/configure-network-virtual-machine.mdx index b31f7e0b42..b71adb00c4 100644 --- a/pages/dedibox-ip-failover/how-to/configure-network-virtual-machine.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-network-virtual-machine.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + When you install your server with a virtualization solution like Proxmox, you can create multiple virtual machines on the physical server. This setup allows you to have separate environments for different services (e.g., mail and web services) or to optimize the server's performance by running several virtual machines. @@ -23,7 +25,7 @@ To communicate on the internet, each of your virtual machines needs an IP addres * IP address of the unique gateway: `62.210.0.1` - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) a Dedibox dedicated server and installed a hypervisor on it diff --git a/pages/dedibox-ip-failover/how-to/configure-reverse-dns.mdx b/pages/dedibox-ip-failover/how-to/configure-reverse-dns.mdx index 24d93963dd..b8b14a26cf 100644 --- a/pages/dedibox-ip-failover/how-to/configure-reverse-dns.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-reverse-dns.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_edit_reverse.webp' +import image2 from './assets/scaleway_update_reverse.webp' + Failover IP addresses allow you to assign multiple IP addresses to your server. This enables you to allocate different IPs to websites, virtual machines, or services. @@ -19,7 +24,7 @@ Your failover IP can be routed at any time to your servers within a few minutes You can add failover IP addresses to each server based on your offer and service level. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -27,10 +32,10 @@ You can add failover IP addresses to each server based on your offer and service ## Configuring Reverse DNS 1. From your Scaleway console, navigate to **Server** > **Network Configuration**. The list of your failover IPs and IP blocks is displayed. - + 2. Click **Edit Reverse DNS**. The list of your current reverse DNS records appears. 3. Enter the new reverse DNS record and click **Update**. - + Ensure that a valid **[A record](/dedibox-dns/concepts/#dns-record)** is configured and pointing to your IP address before updating the reverse DNS. diff --git a/pages/dedibox-ip-failover/how-to/configure-windows.mdx b/pages/dedibox-ip-failover/how-to/configure-windows.mdx index cf4ce07f78..d7bfe2ba2c 100644 --- a/pages/dedibox-ip-failover/how-to/configure-windows.mdx +++ b/pages/dedibox-ip-failover/how-to/configure-windows.mdx @@ -12,24 +12,30 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_windows_ipfo1.webp' +import image2 from './assets/scaleway_windows_ipfo2.webp' +import image3 from './assets/scaleway_windows_ipfo3.webp' + This page shows you how to configure a [failover IP](/dedibox-ip-failover/concepts/#failover-ips) on Dedibox servers running on Windows Server 2019. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) 1. Log into your Dedibox using the **Remote Desktop** client. 2. Open the start menu and type **Ethernet settings**. The Ethernet window displays. - + 3. Click **Change adapter options**. The network connections window displays. 4. Right-click on the internet connection. Then click **Properties** in the pop-up menu. 5. Select **Internet Protocol version 4 (TCP/IPv4)** in the list of connection items and click **Properties**. 6. Enter the static configuration of the principal IP address of the server. Then click **Advanced**. The advanced configuration window displays. - + 7. Click **Add**. Then enter the configuration details for the failover IP. Finally, click **Add**. - + 8. Click **OK** to close the advanced configuration window. Then click **OK** to validate the IP configuration and to close the Ethernet configuration windows. diff --git a/pages/dedibox-ip-failover/how-to/create-virtual-mac.mdx b/pages/dedibox-ip-failover/how-to/create-virtual-mac.mdx index 5cdc98bad4..19f7027b70 100644 --- a/pages/dedibox-ip-failover/how-to/create-virtual-mac.mdx +++ b/pages/dedibox-ip-failover/how-to/create-virtual-mac.mdx @@ -12,16 +12,19 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' + Virtualization requires, in most cases, that you configure additional IP addresses on your dedicated server to provide network connectivity to your virtual machines. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) - Ordered a [failover IP](/dedibox-ip-failover/concepts/#failover-ips) - + In general, two connectivity modes are possible for the networking of virtual machines: diff --git a/pages/dedibox-ip-failover/how-to/order-failover-ip.mdx b/pages/dedibox-ip-failover/how-to/order-failover-ip.mdx index 2a273aa3c9..537d35728e 100644 --- a/pages/dedibox-ip-failover/how-to/order-failover-ip.mdx +++ b/pages/dedibox-ip-failover/how-to/order-failover-ip.mdx @@ -12,6 +12,9 @@ dates: categories: - dedibox-ip-failover --- +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' + Failover IP addresses allow you to have multiple IPs on a server, enabling you to assign a unique IP to each website or virtual machine. Each failover IP can be routed to your servers at any time in just a few minutes using our Account Management Console or API. @@ -22,11 +25,11 @@ By switching a failover IP addresses from one server to another, your hosted ser - Dedibox failover IPs are compatible only with Dedibox servers and cannot be assigned to other products such as Elastic Metal servers or Instances. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) - + ### How to order a failover IP for Dedibox servers diff --git a/pages/dedibox-ip-failover/quickstart.mdx b/pages/dedibox-ip-failover/quickstart.mdx index eaf67f3c01..fa929373d8 100644 --- a/pages/dedibox-ip-failover/quickstart.mdx +++ b/pages/dedibox-ip-failover/quickstart.mdx @@ -9,14 +9,17 @@ tags: dedibox failover-failover IP ip categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' + Failover IPs are IP addresses you can order and move from one server to another (even across data centers), without changing your whole configuration. If your server is out of order, you can move the failover IP to your fallback server, and keep your services available without any downtime. Failover IPs can also be used as additional IP addresses for a single server, for example, if you want to give each website in Plesk its IP. Another functionality of Failover IPs is to create virtual machines on your Dedibox. - + - A Dedibox account logged into the [console](https://console.online.net) - + ## How to order a failover IP diff --git a/pages/dedibox-ipv6/how-to/configure-ipv6-linux.mdx b/pages/dedibox-ipv6/how-to/configure-ipv6-linux.mdx index 2d95ef69f4..a41e9fb4e9 100644 --- a/pages/dedibox-ipv6/how-to/configure-ipv6-linux.mdx +++ b/pages/dedibox-ipv6/how-to/configure-ipv6-linux.mdx @@ -12,8 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) diff --git a/pages/dedibox-ipv6/how-to/configure-ipv6-windows.mdx b/pages/dedibox-ipv6/how-to/configure-ipv6-windows.mdx index 0e7aa4fc11..43e611eefd 100644 --- a/pages/dedibox-ipv6/how-to/configure-ipv6-windows.mdx +++ b/pages/dedibox-ipv6/how-to/configure-ipv6-windows.mdx @@ -12,8 +12,15 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway_ipv6_regedit.webp' +import image2 from './assets/scaleway_ipv6_regedit_edit.webp' +import image3 from './assets/scaleway_ipv6_config_win.webp' +import image4 from './assets/scaleway_ipv6_ping6_win.webp' + + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -31,16 +38,16 @@ categories: 1. Launch the **Registry Editor** by typing `regedit.exe` in the start menu: - + 2. Scroll down until you reach the following setting: `HKEY_LOCAL_MACHINE\System\CurrentControlSet\services\TCPIP6\Parameters` and edit the value `Dhcpv6DUID` with the DUID of your block by double clicking on the default value: - + ## How to configure IPv6 connectivity 1. Go to your network settings, and double-click on your internet connection. 2. Open the connection details and enter the IPv6 settings. Set the IP of the machine to an IPv6 address of your subnet and the netmask: - + 3. Once you have saved the configuration, open a terminal and test the connection by running a `ping -6 google.com` or `tracert -6 google.com`: - + diff --git a/pages/dedibox-ipv6/how-to/create-subnet.mdx b/pages/dedibox-ipv6/how-to/create-subnet.mdx index 067e4dd264..1c85130597 100644 --- a/pages/dedibox-ipv6/how-to/create-subnet.mdx +++ b/pages/dedibox-ipv6/how-to/create-subnet.mdx @@ -12,6 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_ipv6_list.webp' + You can split your IPv6 prefix into several subnets and use them on your Dedibox servers in all locations. Each subnet has its own [DUID](/dedibox-ipv6/concepts/#duid) and can be configured individually. @@ -20,7 +24,7 @@ You can split your IPv6 prefix into several subnets and use them on your Dedibox * You can create as many /64 subnets as you have failover IPs. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -28,7 +32,7 @@ You can split your IPv6 prefix into several subnets and use them on your Dedibox 1. Click **Server** > **Network configuration** in the Dedibox console. The network configuration pages displays. Scroll down to the IPv6 network configuration section. 2. Click the settings icon (cogwheel) next to your `/48` prefix. Then click **Create subnet**. - + 3. Select the subnet you want to create from the drop-down list. Then click **Create subnet**. The subnet is created and visible in the list of your IPv6 subnets along with its DUID. diff --git a/pages/dedibox-ipv6/how-to/debug-ipv6.mdx b/pages/dedibox-ipv6/how-to/debug-ipv6.mdx index 4a220d28c2..edd75996a8 100644 --- a/pages/dedibox-ipv6/how-to/debug-ipv6.mdx +++ b/pages/dedibox-ipv6/how-to/debug-ipv6.mdx @@ -13,8 +13,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) - An [RPN SAN](https://www.scaleway.com/en/dedibox/storage/) diff --git a/pages/dedibox-ipv6/how-to/enable-ipv6-slaac.mdx b/pages/dedibox-ipv6/how-to/enable-ipv6-slaac.mdx index ec6d8366da..520602fd17 100644 --- a/pages/dedibox-ipv6/how-to/enable-ipv6-slaac.mdx +++ b/pages/dedibox-ipv6/how-to/enable-ipv6-slaac.mdx @@ -12,6 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_ipv6_slaac.webp' + Enabling IPv6 SLAAC assigns a single `/128` IPv6 prefix to your server, providing one usable IPv6 address. This IP is statically linked to your server and cannot be attributed to another server. @@ -19,7 +23,7 @@ Enabling IPv6 SLAAC assigns a single `/128` IPv6 prefix to your server, providin This feature is not yet available for all servers. Only compatible servers will show the related button. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -28,7 +32,7 @@ Enabling IPv6 SLAAC assigns a single `/128` IPv6 prefix to your server, providin 1. Click **Server** > **Server list** to display a list of all your servers. 2. Click **Manage** next to the server you want to configure. The server's status page displays. 3. Scroll down to the servers network section and click **Activate IPv6 SLAAC**: - + Your server's IPv6 SLAAC is now activated and displays in the network section. diff --git a/pages/dedibox-ipv6/how-to/request-prefix.mdx b/pages/dedibox-ipv6/how-to/request-prefix.mdx index 39b4617f11..f6fba5e4ee 100644 --- a/pages/dedibox-ipv6/how-to/request-prefix.mdx +++ b/pages/dedibox-ipv6/how-to/request-prefix.mdx @@ -12,6 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_order_ipv6.webp' + All Scaleway Dedibox dedicated servers support IPv6. You can request a free `/48` IPv6 prefix for your account, which can be divided into multiple `/56` or `/64` subnets. @@ -19,14 +23,14 @@ All Scaleway Dedibox dedicated servers support IPv6. You can request a free `/48 IPv6 support is available for all Dedibox servers. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) 1. Click **Server** > **Network configuration** in the Dedibox console. The network configuration page displays. 2. Scroll to the bottom of the page and click **Order a free /48 IPv6 block**: - + The IPv6 prefix is delivered within 30 minutes and is visible on the network configuration page. diff --git a/pages/dedibox-ipv6/quickstart.mdx b/pages/dedibox-ipv6/quickstart.mdx index 4e2f3d1b40..2fc6a4260f 100644 --- a/pages/dedibox-ipv6/quickstart.mdx +++ b/pages/dedibox-ipv6/quickstart.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + IPv6 stands as the latest iteration of the Internet Protocol (IP) used to allocate addresses across the web. Each IPv6 address is composed of 128 bits. When expressed in a human-friendly format, an IPv6 address takes the form of eight sets of four hexadecimal digits, with each set accounting for 16 bits. These sets are separated by colons, such as in `2001:0DB8:0000:0003:0000:01FF:0000:002E`. An alternate representation could be `2001:DB8::3:0:1FF:0:2E`. The Scaleway Dedibox network fully supports IPv6. IPv6 can serve as your server's primary IP and also as a [failover IP](/dedibox-ip-failover/concepts/#failover-ips) utilizing the concept of a [virtual MAC address](/dedibox-ip-failover/concepts/#virtual-mac-address). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) diff --git a/pages/dedibox-kvm-over-ip/how-to/dell-idrac6.mdx b/pages/dedibox-kvm-over-ip/how-to/dell-idrac6.mdx index de6591a404..0e415006cb 100644 --- a/pages/dedibox-kvm-over-ip/how-to/dell-idrac6.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/dell-idrac6.mdx @@ -12,9 +12,18 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_idrac.webp' +import image2 from './assets/scaleway_idrac_console.webp' +import image3 from './assets/scaleway_idrac_launch_console.webp' +import image4 from './assets/scaleway_idrac6_virtual_console.webp' +import image5 from './assets/scaleway_idrac6_boot_manager.webp' +import image6 from './assets/scaleway_idrac6_virtual_cd.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with DELL iDRAC 6. - + - A Dedibox account logged into the [console](https://console.online.net) - Installed [Podman](https://podman.io/getting-started/installation) on your machine @@ -26,7 +35,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Click **Server** > **Server List** in your Dedibox console. The list of your dedicated servers displays. 2. Click the name of the server you want to access. The server's status page displays. 3. Click **iDRAC** in the menu on the right. A pop-up displays. - + 4. Accept the terms for iDRAC access by clicking **I Accept**. 5. Enter the authorized IPv4 address for the iDRAC connection. The IP address of your internet connection is already pre-filled in the form. Then click **Create** to generate your credentials. @@ -71,11 +80,11 @@ If you do not want to use Docker to access the KVM-over-IP device of your server 1. Open the connection URL of your iDRAC in your web browser, then log in using the credentials displayed during access creation. 2. Click **Console/Media** the top menu. - + 3. Click **Launch Virtual Console**. - + 4. Download and execute the Java web start file. The virtual console window displays. - + **Security warning:** To execute the Java applet, you may need to set your Java security settings to **Low**. This may pose a security risk to your system. Please exercise caution and consider using Docker instead. @@ -90,9 +99,9 @@ You can use the virtual console to install an operating system on your server. 6. Click **Add Image...** and select the ISO file containing your operating system. Keep the window open. 7. Go back to the virtual console window and click **Power** > **Reboot** to restart the machine. 8. During the boot process, press **F11** to access the BIOS boot manager. - + 9. Select **Virtual CD** to boot the server using the ISO file mounted in the virtual CD drive. - + The boot process may take a while, depending on your internet connection's available upstream bandwidth. diff --git a/pages/dedibox-kvm-over-ip/how-to/dell-idrac7.mdx b/pages/dedibox-kvm-over-ip/how-to/dell-idrac7.mdx index 663db7ecea..e6f8e05a7c 100644 --- a/pages/dedibox-kvm-over-ip/how-to/dell-idrac7.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/dell-idrac7.mdx @@ -12,10 +12,19 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_idrac.webp' +import image2 from './assets/scaleway_idrac7_dashboard.webp' +import image3 from './assets/scaleway_idrac7_remote_share.webp' +import image4 from './assets/scaleway_idrac7_console.webp' +import image5 from './assets/scaleway_idrac7_bios_boot.webp' +import image6 from './assets/scaleway_idrac7_virtual_cd.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with DELL iDRAC 7. - + - A Dedibox account logged into the [console](https://console.online.net) - A Dedibox server with a [Dell iDRAC 7](https://www.dell.com/support/manuals/en-us/integrated-dell-remote-access-cntrllr-7-v1.50.50/idrac7ug1.50.50-v1/overview) KVM-over-IP device @@ -25,7 +34,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Navigate to **Server** > **Server List** in your [Dedibox console](https://console.online.net). A list of your dedicated servers displays. 2. Click the name of the server you wish to access. The server's status page displays. 3. Click **iDRAC** on the right-hand menu. This will prompt a pop-up window to appear. - + 4. Confirm your acceptance of the terms for iDRAC access by clicking **I Accept**. 5. Provide the authorized IPv4 address for the iDRAC connection. The form will autofill with the IP address of your current internet connection. Proceed by clicking **Create** to generate your credentials. @@ -45,9 +54,9 @@ Upon completion, the connection URL and your credentials will be displayed. Clic ### Mounting an ISO 1. Navigate to **Attached Media** in the top menu. This action will display the virtual media page. - + 2. Input the image file path in the form and click **Connect**. - + You can locate the image file path for your OS on our [NAS](http://virtualmedia.online.net).
If your preferred OS is not available on the NAS, contact our support team for assistance. @@ -56,14 +65,14 @@ Upon completion, the connection URL and your credentials will be displayed. Clic ### Accessing the remote console with an ISO mount 1. Click on **Properties** (A), then **Launch** (B) to initiate the virtual console. - + If your server is configured to use Java, you may not be able to access the HTML5 interface. In this case, please contact our support team for assistance. 2. Reboot the server, then press **F11** during the boot process to access the boot manager. 3. Select **BIOS Boot Menu**. - + 4. Choose **iDRAC Virtual CD**. - + Your server boots from the ISO file on the NAS and you can complete the installation of your operating system. diff --git a/pages/dedibox-kvm-over-ip/how-to/dell-idrac8.mdx b/pages/dedibox-kvm-over-ip/how-to/dell-idrac8.mdx index 2e8268c883..0066a7fdc5 100644 --- a/pages/dedibox-kvm-over-ip/how-to/dell-idrac8.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/dell-idrac8.mdx @@ -12,9 +12,17 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_idrac.webp' +import image2 from './assets/scaleway_idrac8_dashboard.webp' +import image3 from './assets/scaleway_idrac8_connect_vm.webp' +import image4 from './assets/scaleway_idrac8_map_cd.webp' +import image5 from './assets/scaleway_idrac8_iso.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with DELL iDRAC 8. - + - A Dedibox account logged into the [console](https://console.online.net) - A Dedibox server with a [DELL iDRAC 8](https://www.dell.com/support/manuals/en-us/idrac8-with-lc-v2.05.05.05/idrac8_2.05.05.05_ug/overview) KVM-over-IP device @@ -33,7 +41,7 @@ To access the KVM-over-IP device using HTML5, follow these steps: 1. Click **Server** > **Server List** in your Dedibox console. The list of your dedicated servers displays. 2. Click the name of the server you want to access. The server's status page displays. 3. Click **iDRAC** in the menu on the right. A pop-up displays. - + 4. Accept the terms for iDRAC access by clicking **I Accept**. 5. Enter the authorized IPv4 address for the iDRAC connection. The IP address of your internet connection is already pre-filled in the form. Then click **Create** to generate your credentials. @@ -45,7 +53,7 @@ The connection URL and your credentials display. Click on the link to access the 1. Open the connection URL of your iDRAC in your web browser, then log in using the credentials displayed during access creation. 2. Click **Launch** in the **Virtual Console Preview** section of the dashboard. The virtual console window displays. - + ## Mounting an ISO file @@ -54,11 +62,11 @@ To mount an ISO file, follow these steps: ### Mounting an ISO file using the iDRAC interface 1. Click **Virtual Media** > **Connect Virtual Media**. - + 2. Click **Virtual Media** > **Map CD/DVD ...**. A pop-up displays. - + 3. Select the installation ISO file on your computer by clicking **Browse**. Then click **Map Device** and reboot the server. - + 4. Press **F12** during the boot process to enter the boot manager. Then select the virtual CD-ROM drive. Your server boots from the ISO file, and you can complete the installation of your operating system. diff --git a/pages/dedibox-kvm-over-ip/how-to/dell-idrac9.mdx b/pages/dedibox-kvm-over-ip/how-to/dell-idrac9.mdx index a3bf485acd..d15903e589 100644 --- a/pages/dedibox-kvm-over-ip/how-to/dell-idrac9.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/dell-idrac9.mdx @@ -12,6 +12,13 @@ dates: categories: - dedibox-servers --- +import image from './assets/scaleway_idrac.webp' +import image2 from './assets/scaleway_idrac9_console.webp' +import image3 from './assets/scaleway_idrac9_console.webp' +import image4 from './assets/scaleway_idrac9_connect_vm.webp' +import image5 from './assets/scaleway_idrac9_map_device.webp' +import image6 from './assets/scaleway_idrac9_boot_manager.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with DELL iDRAC 9. ## Requirements @@ -22,7 +29,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Click **Server** > **Server List** in your Dedibox console. The list of your dedicated servers displays. 2. Click the name of the server you want to access. The server's status page displays. 3. Click **iDRAC** in the menu on the right. A pop-up displays. - + 4. Accept the terms for iDRAC access by clicking **I Accept**. 5. Enter the authorized IPv4 address for the iDRAC connection. The IP address of your internet connection is already pre-filled in the form. Then click **Create** to generate your credentials. @@ -39,21 +46,21 @@ The connection URL and your credentials display. Click on the link to access the 1. Open the connection URL of your iDRAC in your web browser, then log in using the credentials displayed during access creation. 2. Click **Configuration** in the top menu, then **Virtual Console**. The virtual console page displays. Click **Launch Virtual Console**. - + 3. Click **Console Controls**, choose the **Ctrl-Alt-Del** keyboard macro and click **Apply** to reboot the server. ## Accessing the KVM-over-IP device with ISO mounting 1. Open the connection URL of your iDRAC in your web browser, then log in using the credentials displayed during access creation. 2. Click **Configuration** in the top menu, then **Virtual Console**. The virtual console page displays. Click **Launch Virtual Console**. - + 3. Click **Connect Virtual Media** in the virtual console window. The virtual media configuration displays. - + 4. Click **Choose file** (A) in the **Map CD/DVD** section and select your ISO file. Then click **Map Device**. Once the device is mapped, click **Close**. - + 5. Click **Console Controls**, choose the **Ctrl-Alt-Del** keyboard macro and click **Apply** to reboot the server. 6. Press **F11** during the boot process to enter the boot manager. 7. Click **One-shoot UEFI Boot Menu**: - + 8. Click **Virtual Optical Drive**. Your server boots from the ISO file, and you can complete the installation of your operating system. diff --git a/pages/dedibox-kvm-over-ip/how-to/disable-boot-errors-idrac.mdx b/pages/dedibox-kvm-over-ip/how-to/disable-boot-errors-idrac.mdx index bed1073085..74a3e87e98 100644 --- a/pages/dedibox-kvm-over-ip/how-to/disable-boot-errors-idrac.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/disable-boot-errors-idrac.mdx @@ -12,10 +12,16 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-bootstuck.webp' +import image2 from './assets/scaleway-bootstuck2.webp' +import image3 from './assets/scaleway-bootstuck3.webp' + This document shows you how to disable boot errors, where your server gets "stuck" showing the line `“trike the F1 key to continue, F2 to run the system setup program`. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server with a Dell iDRAC controller @@ -26,9 +32,9 @@ This document shows you how to disable boot errors, where your server gets "stuc Your server will boot until it gets stuck as previously described: - + 4. Click in the KVM window, then press **F2**. This allows you to enter the BIOS of your server and make configuration changes. - + 5. Use the arrow keys to go to the line **F1/F2 Prompt on Error**. 6. Press the spacebar to change the value of the line to **Disabled**. 7. Press ESC. You are prompted to save your modifications to the BIOS. @@ -36,6 +42,6 @@ This document shows you how to disable boot errors, where your server gets "stuc The server reboots. You can watch the boot process in the KVM to make sure the server loads the OS correctly. - + diff --git a/pages/dedibox-kvm-over-ip/how-to/hp-ilo.mdx b/pages/dedibox-kvm-over-ip/how-to/hp-ilo.mdx index dd7c1031b6..d9125f89d9 100644 --- a/pages/dedibox-kvm-over-ip/how-to/hp-ilo.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/hp-ilo.mdx @@ -12,10 +12,16 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_ilo.webp' +import image2 from './assets/scaleway_ilo_boot_menu.webp' +import image3 from './assets/scaleway_ilo_boot_options.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with HP iLO. - + - A Dedibox account logged into the [console](https://console.online.net) - A Dedibox server with a KVM-over-IP device: [HP iLO (integrated lights-out)](https://www.hpe.com/us/en/servers/integrated-lights-out-ilo.html) @@ -25,7 +31,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Click **Server** > **Server List** in your Dedibox console. The list of your dedicated servers displays. 2. Click the name of the server you want to access. The server's status page displays. 3. Click **iLO** in the menu on the right. A pop-up displays. - + 4. Accept the terms for iLO access by clicking **I Accept**. 5. Enter the authorized IPv4 address for the iLO connection. The IP address of your internet connection is already pre-filled in the form. Then click **Create** to generate your credentials. @@ -47,9 +53,9 @@ The connection URL and your credentials display. Click on the link to access the 4. Click the menu icon > **Power** > **Reset** to reboot the machine. 5. During reboot, press **F11** to launch the boot menu. - + 6. Press **1** to boot from the virtual CD/DVD drive. - + The server boots into installation mode. Follow the wizard of your operating system to complete the installation. diff --git a/pages/dedibox-kvm-over-ip/how-to/quanta-computer.mdx b/pages/dedibox-kvm-over-ip/how-to/quanta-computer.mdx index 7eb087f99a..83aef80b47 100644 --- a/pages/dedibox-kvm-over-ip/how-to/quanta-computer.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/quanta-computer.mdx @@ -12,10 +12,18 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_KVM.webp' +import image2 from './assets/scaleway_qct_console_redir.webp' +import image3 from './assets/scaleway_qct_virtual_media.webp' +import image4 from './assets/scaleway_qct_add_vm.webp' +import image5 from './assets/scaleway_qct_boot_device.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with Quanta Computer KVM. - + - A Dedibox account logged into the [console](https://console.online.net) - Installed [Java](https://www.java.com/en/download/help/download_options.html) on your local computer @@ -26,7 +34,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Click **Server** > **Server List** in your Dedibox console. The list of your dedicated servers displays. 2. Click the name of the server you want to access. The server's status page displays. 3. Click **KVM OVER IP** in the menu on the right. A pop-up displays. - + 4. Accept the terms for KVM access by clicking **I Accept**. 5. Enter the authorized IPv4 address for the KVM connection. The IP address of your internet connection is already pre-filled in the form. Then click **Create** to generate your credentials. @@ -39,14 +47,14 @@ The connection URL and your credentials display. Click on the link to access the 1. Open the connection URL of your KVM in your web browser, then log in using the credentials displayed during access creation. 2. Click **Remote Control** > **Console Redirection** in the menu. Download and run the Java applet. - + 3. Click **Media** > **Virtual Media** in the KVM window. - + 4. Click **Browse** in the **CD/DVD Media I** section and select your operating system's ISO file. Then click **Connect CD/DVD**: - + 5. Reboot the server and press **F11** to enter the boot menu once the Quanta Computer logo displays. 6. Select the boot device **AMI Virtual CDROM0** to boot from the ISO file: - + The server boots into installation mode. Follow the wizard of your operating system to complete the installation. diff --git a/pages/dedibox-kvm-over-ip/how-to/quantaplex.mdx b/pages/dedibox-kvm-over-ip/how-to/quantaplex.mdx index 9fc05a1ad9..e8243709c6 100644 --- a/pages/dedibox-kvm-over-ip/how-to/quantaplex.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/quantaplex.mdx @@ -12,10 +12,20 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_KVM.webp' +import image2 from './assets/scaleway_quantaplex_remote_control.webp' +import image3 from './assets/scaleway_quantaplex_launch_kvm.webp' +import image4 from './assets/scaleway_quantaplex_browse_file.webp' +import image5 from './assets/scaleway_quantaplex_start_media.webp' +import image6 from './assets/scaleway_quantaplex_f11.webp' +import image7 from './assets/scaleway_quantaplex_vcdrom.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a QuantaPlex Dedibox. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox server](/dedibox/how-to/install-a-server/) with a [Quanta Computer QuantaPlex](https://www.qct.io) KVM-over-IP device @@ -25,7 +35,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Navigate to **Server** > **Server List** in your [Dedibox console](https://console.online.net/) to view the list of your dedicated servers. 2. Click the name of the server you wish to access. This will open the server's status page. 3. Click **KVM OVER IP** on the right-hand menu. A pop-up window displays. - + 4. Confirm your acceptance of the terms for KVM access by clicking **I Accept**. 5. Provide the authorized IPv4 address for the KVM connection. The form will autofill with the IP address of your current internet connection. Proceed by clicking **Create** to generate your credentials. @@ -38,19 +48,19 @@ Upon completion, the connection URL and your credentials will be displayed. Clic 1. Open the connection URL of your KVM in your web browser, then log in using the credentials provided during access creation. 2. Navigate to **Remote Control** in the side menu of the BMC device. - + 3. Click **Launch KVM** on the **Remote Control** page: - + 4. In the KVM window, click **Browse File** and select your operating system's ISO file. - + 5. Click **Start Media** to mount the virtual drive and reboot the machine: - + 6. During the boot process, press **F11** to enter the boot menu: - + Select the boot device **AMI Virtual CDROM0** to boot from the ISO file: - + The server will boot into installation mode. Follow the operating system's installation wizard to complete the installation. diff --git a/pages/dedibox-kvm-over-ip/how-to/supermicro.mdx b/pages/dedibox-kvm-over-ip/how-to/supermicro.mdx index 614262c233..72a7727443 100644 --- a/pages/dedibox-kvm-over-ip/how-to/supermicro.mdx +++ b/pages/dedibox-kvm-over-ip/how-to/supermicro.mdx @@ -12,10 +12,23 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_KVM.webp' +import image2 from './assets/scaleway_supermicro_vm.webp' +import image3 from './assets/scaleway_supermicro_nas.webp' +import image4 from './assets/scaleway_supermicro_boot_mgr.webp' +import image5 from './assets/scaleway_supermicro_vcdrom.webp' +import image6 from './assets/scaleway_supermicro_install.webp' +import image7 from './assets/scaleway_supermicro_vdrive.webp' +import image8 from './assets/scaleway_supermicro_drivers.webp' +import image9 from './assets/scaleway_supermicro_network.webp' +import image10 from './assets/scaleway_supermicro_ping.webp' + This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) on a Dedibox with Supermicro KVM. - + - A Dedibox account logged into the [console](https://console.online.net) - Installed [Java](https://www.java.com/en/download/help/download_options.html) on your local computer @@ -26,7 +39,7 @@ This page shows you how to use [KVM](/dedibox-kvm-over-ip/concepts/#kvm-over-ip) 1. Access your [Dedibox console](https://console.online.net/) and navigate to **Server** > **Server List**. This will display a list of your dedicated servers. 2. Select the server you wish to access by clicking its name. This will open the server's status page. 3. Click **KVM OVER IP** on the right-hand menu. A pop-up window displays. - + 4. Confirm your acceptance of the terms for KVM access by clicking **I Accept**. 5. Provide the authorized IPv4 address for the KVM connection. The form will autofill with the IP address of your current internet connection. Then click **Create** to generate your credentials. @@ -39,9 +52,9 @@ Once completed, the connection URL and your credentials will be displayed. Click 1. Open the connection URL of your KVM in your web browser and log in using the credentials provided during access creation. 2. In the KVM menu, click on **Virtual Media** > **CD-ROM Image**: - + 3. Enter the image file path of your OS image: - + You can find the image file path for your OS on our [NAS](http://virtualmedia.online.net).
@@ -52,13 +65,13 @@ Once completed, the connection URL and your credentials will be displayed. Click A Java security warning may appear. Validate it to launch the KVM applet. 5. Reboot the server and press **F11** to enter the boot menu: - + 6. Select the boot device **ATEN Virtual CDROM** to boot from the ISO file: - + Your server will boot into installation mode. Follow the operating system's installation wizard to complete the installation. - + ## Installing Windows network drivers @@ -72,13 +85,13 @@ Microsoft Windows Server does not support the network adapter used in Supermicro 4. Access the KVM-over-IP device by clicking **Remote Console Preview**. 5. Click **Virtual Media** > **Virtual Storage**. A pop-up will appear: - + 6. Select **ISO file** and choose the downloaded ISO image. Then click **Plug in** > **OK**. 7. Double-click on the CD-ROM drive in your Windows installation and launch the setup tool. Accept the terms and conditions and click **Intel PRO Network Connections Drivers**: - + 8. Complete the installation of the network drivers using the setup wizard: - + 9. Test the network connection of your Dedibox using the `ping` command: - + diff --git a/pages/dedibox-kvm-over-ip/quickstart.mdx b/pages/dedibox-kvm-over-ip/quickstart.mdx index 0620c9823e..7622dc7b3e 100644 --- a/pages/dedibox-kvm-over-ip/quickstart.mdx +++ b/pages/dedibox-kvm-over-ip/quickstart.mdx @@ -11,6 +11,11 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-idrac.webp' +import image2 from './assets/scaleway-ilo.webp' + An **I**ntelligent **P**latform **M**anagement **I**nterface (IPMI) is an industry standard to describe the subsystem of a server providing remote management and monitoring capabilities. IPMI allows you to manage and monitor a server even if it is powered off or unresponsive, by using a network connection to the hardware. IPMI is made possible by the **B**aseboard **M**anagement **C**ontroller, an independent piece of hardware connected to your network card, composed of an I2C bus and a dedicated processor. @@ -31,7 +36,7 @@ Actions that can be carried out via IPMI include: In this document, we show you how to access the IPMI for a Dell or HP server. See the [KVM-over-IP](/dedibox-kvm-over-ip/) documentation for information about other server models. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server with a dedicated KVM over IP device @@ -51,7 +56,7 @@ IPMI is a standard specification for a remote management subsystem. On a Dell se The URL connection and your credentials display. Click the link to access the iDRAC interface. - + 6. Use the interface to monitor and manage your server's hardware: - The **System** tabs let you view various system information including system details, logs, and power status. You can also use the **Console/Media** > **Virtual Media** tab to install your server remotely with a custom OS by connecting virtual media. Click **Remote Access Controller** under **System Details** to launch the KVM. - The **iDDRAC** tabs show you information about the iDRAC itself. @@ -72,7 +77,7 @@ IPMI is a standard specification for a remote management subsystem. On an HPE se The URL connection and your credentials display. Click on the link to access the iLO interface. - + 6. Use the interface to monitor and manage your server's hardware: - The **Information** pages let you view various system information including system details, logs, and diagnostics. - The **Remote Console** pages let you launch the KVM. diff --git a/pages/dedibox-network/how-to/configure-network-netplan.mdx b/pages/dedibox-network/how-to/configure-network-netplan.mdx index 57bf9f92d7..0c2128f5c2 100644 --- a/pages/dedibox-network/how-to/configure-network-netplan.mdx +++ b/pages/dedibox-network/how-to/configure-network-netplan.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + Since the release of its version 18.04, Bionic Beaver, [Ubuntu](http://www.ubuntu.org) has switched to [Netplan](http://netplan.io) for the network interface configuration. It is a [YAML](https://yaml.org/spec/1.2/spec.html) based configuration system, which simplifies the configuration process. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox-network/how-to/subscribe-to-jmrp.mdx b/pages/dedibox-network/how-to/subscribe-to-jmrp.mdx index 5002212eb1..b147b520fd 100644 --- a/pages/dedibox-network/how-to/subscribe-to-jmrp.mdx +++ b/pages/dedibox-network/how-to/subscribe-to-jmrp.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + Subscribing to the Junk Mail Reporting Program (JMRP) allows you to register your IP addresses with Microsoft's mail delivery system. This registration helps you proactively manage your IP reputation by enabling you to take appropriate actions if your IP is flagged as a source of spam, thus reducing the risk of blacklisting. @@ -25,7 +27,7 @@ Enrolling in JMRP provides several advantages: Following these steps will help you maintain a clean email delivery system and protect your IP reputation. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox-network/reference-content/anti-ddos.mdx b/pages/dedibox-network/reference-content/anti-ddos.mdx index e653835e21..f1d0d5d7c4 100644 --- a/pages/dedibox-network/reference-content/anti-ddos.mdx +++ b/pages/dedibox-network/reference-content/anti-ddos.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import image from './assets/scaleway-offre-ddos.webp' + Scaleway Dedibox provides comprehensive anti-DDoS protection for all its dedicated servers at no extra cost. This robust anti-DDoS system is built with state-of-the-art technology, leveraging advanced detection and mitigation algorithms powered by Arbor® Networks Peakflow and Sevi® M6-NG devices. @@ -19,7 +21,7 @@ This robust anti-DDoS system is built with state-of-the-art technology, leveragi Through swift identification of potential threats, Dedibox efficiently filters out malicious traffic, guaranteeing uninterrupted service delivery. Our strategically positioned equipment within the network core enables automatic detection of DDoS attacks, swiftly neutralizing any malicious activity and ensuring the seamless operation of your services. - + If your activities require a higher level of management on the threat management system, two upgrade plans are available: Advanced and Curative. For more information, see the [anti-DDoS offers page](https://www.scaleway.com/en/dedibox/ddos-protection/). diff --git a/pages/dedibox-network/troubleshooting/index.mdx b/pages/dedibox-network/troubleshooting/index.mdx index 8a7642f3c3..b64be4cee6 100644 --- a/pages/dedibox-network/troubleshooting/index.mdx +++ b/pages/dedibox-network/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: DediboxProductIcon ## Featured Pages - - - + diff --git a/pages/dedibox-rpn/how-to/configure-rpnv1.mdx b/pages/dedibox-rpn/how-to/configure-rpnv1.mdx index 8be0afdca2..1d2ff8c9e5 100644 --- a/pages/dedibox-rpn/how-to/configure-rpnv1.mdx +++ b/pages/dedibox-rpn/how-to/configure-rpnv1.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + The private RPNv1 network is connected to the second physical interface of your Dedibox. It is connected to a totally secure network, different from the one you use to connect to the internet. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) with RPNv1 connectivity diff --git a/pages/dedibox-rpn/how-to/configure-rpnv2.mdx b/pages/dedibox-rpn/how-to/configure-rpnv2.mdx index d0adea266d..62599e4040 100644 --- a/pages/dedibox-rpn/how-to/configure-rpnv2.mdx +++ b/pages/dedibox-rpn/how-to/configure-rpnv2.mdx @@ -12,6 +12,12 @@ dates: categories: - dedibox-network --- +import image from './assets/scaleway_esxi_vswitch.webp' +import image2 from './assets/scaleway_esxi_rpn.webp' +import image3 from './assets/scaleway_esxi_port_group.webp' +import image4 from './assets/scaleway_esxi_vlan.webp' +import image5 from './assets/scaleway_proxmox_rpn.webp' + [RPNv2](/dedibox-rpn/concepts/#rpn-v2) can be configured on any operating system supporting VLANs. The feature is available for selected Dedibox servers. @@ -158,13 +164,13 @@ On ESXi, you can create virtual switches that talk directly on the corresponding 1. Check your network interfaces, to discover which one corresponds to the RPN interface. In the following example, the RPN interface is `vmnic2`. 2. Enter the **Virtual switch** section and add a new one by clicking **Add standard virtual switch**: - + 3. Enter a name for the virtual switch, set the MTU to `9000`, and select the RPN interface as uplink: - + 4. Click the **Port groups** tab and click **Add port group** to create a new one: - + 5. Enter a name for the new port group and set the VLAN IP, then select the virtual switch and click **Add**. - + The virtual switch is configured now. @@ -179,7 +185,7 @@ Create a NIC directly linked to your new Group (**VM Network** in the example ab 1. Login to the Proxmox web interface and click **System** > **Network**. 2. Click **Create** on the network page. 3. Configure your bridge with a `bridge_port` which will be named after your RPN NIC, and your VLAN ID. - + For instance, if your RPN NIC is eth2 and your VLAN ID 3900, name it `eth2.3900`. diff --git a/pages/dedibox-rpn/how-to/connect-rpn-san-windows.mdx b/pages/dedibox-rpn/how-to/connect-rpn-san-windows.mdx index e9c70f5ef9..3777ae034e 100644 --- a/pages/dedibox-rpn/how-to/connect-rpn-san-windows.mdx +++ b/pages/dedibox-rpn/how-to/connect-rpn-san-windows.mdx @@ -12,41 +12,52 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_windows_server_san_01.webp' +import image2 from './assets/scaleway_windows_server_san_02.webp' +import image3 from './assets/scaleway_windows_server_san_03.webp' +import image4 from './assets/scaleway_windows_server_san_04.webp' +import image5 from './assets/scaleway_windows_server_san_05.webp' +import image6 from './assets/scaleway_windows_server_san_06.webp' +import image7 from './assets/scaleway_windows_server_san_07.webp' +import image8 from './assets/scaleway_windows_server_san_08.webp' + [RPN SAN](/dedibox-rpn/concepts/#rpn-san) is an iSCSI target that can be mounted on Windows Server 2012 and later, including Windows Server 2019 and 2022, enabling it to operate as a standard disk within the system. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) - An [RPN SAN](https://www.scaleway.com/en/dedibox/storage/) 1. Launch the **Server Manager** application of Windows and click **Tools** > **iSCSI Initiator**. - + 2. Click the **Discovery** tab to add the SAN server: - + The initiator is not activated by the default on the system start. If you start it for the first time, you are asked if you want to start it during the system start. Click **yes** to confirm. 3. Click the **Targets** tab and select the target you want to connect to. Click **Connection** to confirm. The target will then be connected to the server as an unformatted disk. - + 4. Launch the control panel and click **System and Security** > **Create and format hard disk partitions** in the **Administrative Tools** section. - + 5. The disk can be configured from the **Storage** > **Disk Management** section of the **Computer Management** tool. By default, it displays as offline. - + 6. Right-click on it and click **Online** to activate the disk. The system will propose the type of partition table to use for your disk. - + For a 1 TB SAN, keep the default choice. If you have a larger SAN, select GPT, Windows can not handle partitions larger than 2 TB with anything except GPT. 7. Format the disk with a file system (NTFS). Click **Next** > **Finish** to confirm formatting the disk. - + Once finished formatting (in about 10 minutes using quick formatting), the hard disk drive should be accessible from the server manager as a regular disk: - + For additional information, refer to [Microsoft's Windows storage configuration guide](https://docs.microsoft.com/en-us/windows-server/storage/). diff --git a/pages/dedibox-rpn/how-to/connect-rpn-san.mdx b/pages/dedibox-rpn/how-to/connect-rpn-san.mdx index cca6bc9bdd..653e08a4c5 100644 --- a/pages/dedibox-rpn/how-to/connect-rpn-san.mdx +++ b/pages/dedibox-rpn/how-to/connect-rpn-san.mdx @@ -12,10 +12,16 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_rpn_san_manage.webp' +import image2 from './assets/scaleway_rpn_san_add.webp' +import image3 from './assets/scaleway_rpn_san_added.webp' + [RPN SAN](https://www.scaleway.com/en/dedibox/storage/) is a performance-oriented SAN storage network solution (Storage Area Network) accessible in block mode and available in iSCSI through the RPN private network of your Dedibox. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -30,9 +36,9 @@ categories: 1. Enter the [RPN SAN configuration](https://console.online.net/en/server/rpn/san) by clicking **Storage** > **RPN SAN**. The list of your SANs displays. 2. Click **Manage** next to the SAN you want to configure: - + 3. Configure access to the SAN. You can allow connections either by using the server ID or by their RPN IP address. Then Click **Save** to validate the configuration. - + The allowed server(s) are listed on the SAN overview page. @@ -53,6 +59,6 @@ The allowed server(s) are listed on the SAN overview page. 1. Access the [RPN group](https://console.online.net/en/server/rpn) configuration by clicking **RPN** > **RPN groups** The list of your RPN groups displays. 2. Click **Create group**. The group creation form displays. Enter a name for the new group and tick the checkboxes of your Dedibox and the RPN SAN you want to grant access to. Then click **Create group** to confirm. The RPN group is scheduled for creation. 3. Once the status of your group changes to **Active** the group is ready to be used and your Dedibox is able to communicate with the SAN. - + diff --git a/pages/dedibox-rpn/how-to/find-rpn-gateway.mdx b/pages/dedibox-rpn/how-to/find-rpn-gateway.mdx index fd22430d8b..9fc6e15674 100644 --- a/pages/dedibox-rpn/how-to/find-rpn-gateway.mdx +++ b/pages/dedibox-rpn/how-to/find-rpn-gateway.mdx @@ -12,13 +12,15 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + Your RPNv1 gateway may differ from one Dedibox to another for technical reasons. It is normally pushed by DHCP, and configured automatically. However, in some cases you may need to know the details of the gateway. You can find the RPNv1 gateway for your Dedibox in the Scaleway console, or by running the following commands. - + - A Dedibox account logged into the [Dedibox console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) with an RPN interface diff --git a/pages/dedibox-rpn/how-to/mount-rpn-san-linux.mdx b/pages/dedibox-rpn/how-to/mount-rpn-san-linux.mdx index edca215f37..0e35b6ad02 100644 --- a/pages/dedibox-rpn/how-to/mount-rpn-san-linux.mdx +++ b/pages/dedibox-rpn/how-to/mount-rpn-san-linux.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + You can mount RPN SAN volumes on Linux machines using Open-iSCSI. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) diff --git a/pages/dedibox-rpn/how-to/use-rpn-san-esxi-v7.mdx b/pages/dedibox-rpn/how-to/use-rpn-san-esxi-v7.mdx index e06b189a6d..7f593d8c4f 100644 --- a/pages/dedibox-rpn/how-to/use-rpn-san-esxi-v7.mdx +++ b/pages/dedibox-rpn/how-to/use-rpn-san-esxi-v7.mdx @@ -12,13 +12,26 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-esxi7-dashboard.webp' +import image2 from './assets/scaleway-esxi7-ssh.webp' +import image3 from './assets/scaleway-enable_ssh.webp' +import image4 from './assets/scaleway-rpn_switch.webp' +import image5 from './assets/scaleway-vmkernel_nic.webp' +import image6 from './assets/scaleway-esxi7-vmnic.webp' +import image7 from './assets/scaleway-rpn_switch_connected.webp' +import image8 from './assets/scaleway-configure_iscsi.webp' +import image9 from './assets/scaleway-datastore_device.webp' +import image10 from './assets/scaleway-datastore_list.webp' + Due to VMware's acquisition by Broadcom, the free edition of VMware vSphere Hypervisor is no longer available on the VMware website. For more details, check out [the EOL of free vSphere Hypervisor](https://knowledge.broadcom.com/external/article?legacyId=2107518). Please note that the following content is provided as-is, without any guarantee of functionality. We suggest considering alternative hypervisors such as Proxmox. You can learn how to [deploy virtual machines with Proxmox on Scaleway Dedibox](/tutorials/configure-failover-proxmox/). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -39,10 +52,10 @@ We suggest considering alternative hypervisors such as Proxmox. You can learn ho Once logged in, the ESXi dashboard displays. - + 2. Click **Manage** in the menu on the left. Then click the **Services** tab to display a list of available services. 3. Select **TSM-SSH**, then click **Start** to activate the SSH service. - + ### Configure ESXi to access the RPN @@ -50,13 +63,13 @@ We suggest considering alternative hypervisors such as Proxmox. You can learn ho 1. Connect to your Dedibox server by typing the server's IP address in a web browser. The ESXi login displays. Enter your credentials to log in. 2. Click **Actions** > **Services** > **Enable Secure Shell (SSH)**: - + The following warning displays once SSH is enabled: **SSH is enabled on this host. You should disable SSH unless it is necessary for administrative purposes**. 3. Create a new **Virtual Switch** by clicking on **Networking** > **Virtual Switches** > **Add Standard Virtual Switch**. Configure it as shown in the following example: - + 4. Create a new **VMkernel NIC** by clicking on **Networking** > **VMkernel NICs** > **Add VMkernel NIC** and configure it as follows. - + * Make sure to configure Jumboframes (MTU 9000) both for the switch and the NIC. @@ -76,7 +89,7 @@ We suggest considering alternative hypervisors such as Proxmox. You can learn ho vi vmknics.json ``` 9. Replace the MAC address of your RPN VMkernel NIC with your server's private interface MAC address (displayed in your Dedibox console interface). - + 10. Import the new configuration: ``` configstorecli config current set -c esx -g network -k vmknics -i vmknics.json --overwrite @@ -85,7 +98,7 @@ We suggest considering alternative hypervisors such as Proxmox. You can learn ho ### Setting RPN routes 1. Enter the ESXi web interface, click **Networking** > **Virtual Switches** > **RPN Switch** and check the IP address of the VMkernel NIC. It now has the RPN IP auto-assigned to the interface via DHCP: - + 2. Reactivte the SSH service and connect to the machine via SSH. 3. Run the following command to add the RPN route: ``` @@ -123,7 +136,7 @@ To be able to communicate with the RPN-SAN, you need to allow your servers to ac 5. Connect to the ESXi web interface of your server. 6. Click **Storage** > **Adapters** > **Software iSCSI**. A configuration pop-up displays. 7. **Enable** the service. Click **Add port binding** and add the RPN Network. Then click **Add dynamic target** and enter the address of your SAN. Then, click **Save configuration**: - + ESXi rescans for devices, and you can see the new iSCSI disk in the **Devices** tab of the storage section. @@ -134,13 +147,13 @@ To use the RPN-SAN with ESXi, you need to create a new datastore. To do so, foll 1. Connect to the ESXi web interface, then click **Storage** > **Datastores** > **New Datastore**. 2. Select **Create new VMFS datastore** and click **Next**. 3. Enter a name for the new datastore and select the RPN-SAN iSCSI disk from the list of available devices. Then click **Next**: - + 4. Configure the partitioning of the datastore. Then click **Next**. A summary displays. 5. Validate all given information and click **Finish** to format the device. Be careful, formatting the device deletes all data you may have stored on it. 6. The newly created datastore displays in the datastore list and is ready for use: - + diff --git a/pages/dedibox-rpn/how-to/use-rpn-san-esxi.mdx b/pages/dedibox-rpn/how-to/use-rpn-san-esxi.mdx index 8aafc27bbb..572c4caf12 100644 --- a/pages/dedibox-rpn/how-to/use-rpn-san-esxi.mdx +++ b/pages/dedibox-rpn/how-to/use-rpn-san-esxi.mdx @@ -12,13 +12,34 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_esxi-san-en-01.webp' +import image2 from './assets/scaleway_esxi-san-en-02.webp' +import image3 from './assets/scaleway_esxi-san-en-03.webp' +import image4 from './assets/scaleway_esxi-san-en-04.webp' +import image5 from './assets/scaleway_esxi-san-en-05.webp' +import image6 from './assets/scaleway_esxi-san-en-06.webp' +import image7 from './assets/scaleway_esxi-san-en-07.webp' +import image8 from './assets/scaleway_esxi-san-en-08.webp' +import image9 from './assets/scaleway_esxi-san-en-09.webp' +import image10 from './assets/scaleway_esxi-san-en-10.webp' +import image11 from './assets/scaleway_esxi-san-en-11.webp' +import image12 from './assets/scaleway_esxi-san-en-12.webp' +import image13 from './assets/scaleway_esxi-san-en-13.webp' +import image14 from './assets/scaleway_esxi-san-en-14.webp' +import image15 from './assets/scaleway_esxi-san-en-15.webp' +import image16 from './assets/scaleway_esxi-san-en-16.webp' +import image17 from './assets/scaleway_esxi-san-en-17.webp' +import image18 from './assets/scaleway_esxi-san-en-18.webp' + Due to VMware's acquisition by Broadcom, the free edition of VMware vSphere Hypervisor is no longer available on the VMware website. For more details, check out [the EOL of free vSphere Hypervisor](https://knowledge.broadcom.com/external/article?legacyId=2107518). Please note that the following content is provided as-is, without any guarantee of functionality. We suggest considering alternative hypervisors such as Proxmox. You can learn how to [deploy virtual machines with Proxmox on Scaleway Dedibox](/tutorials/configure-failover-proxmox/). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -34,22 +55,22 @@ We suggest considering alternative hypervisors such as Proxmox. You can learn ho 1. Start the vSphere client or log in using the web interface. 2. Click the Configuration tab (1), then click **Security Profile** (2) in the software panel. - + 3. Click **Properties** in the Services section. - + 4. Select SSH (1) then click options (2). Select **Start and stop manually** (3) and launch the service manually (4). - + ### Configure ESXi to access the RPN #### Configuration in the ESXi interface 1. Go to **Configuration** > **Networking** (1). Then, click **Add Networking** (2). - + 2. Create a new VMKernel named **RPN**, attached to the RPN network card. - + - + For the next step, validate the windows by choosing **Automatic recovery** for the IP addressing. @@ -60,11 +81,11 @@ For the next step, validate the windows by choosing **Automatic recovery** for t #### Configuration of the MTU 9000 1. Go to **Configuration** > **Networking** > **Properties...** (of vSwitch1). - + 2. Select the vSwitch (1) and edit it (2). - + 3. Set the MTU to **9000**, then confirm and quit. - + ### ESXi configuration @@ -107,26 +128,26 @@ For the next step, validate the windows by choosing **Automatic recovery** for t #### Configuration from the ESXi interface 1. Go back to **Configuration**, then click **Storage Adapter** (1) followed by **Add...** (2). - + 2. Select **Add Software iSCSI Adapter**, then, click **OK**. - + A new device created `vmhba32` should appear in the adapter list. 3. Click the device (1), then, go to **Properties** (2). - + 4. Go to the **Dynamic Discovery** tab (1), then click on **Add...** (2). - + 5. Enter the RPN server address in the **iSCSI Server** box (the address is available in your Dedibox console). - + 6. Click **OK** > **Close**. Then accept the rescan that is proposed. - + * The IET disk is displayed in the device list in the bottom panel. 7. Go to **Configuration** > **Storage** (1) > **Add storage...** (2). - + 8. Select **Disk/LUN**. - + 9. Select the Target, then click **Next**. - + Finish the configuration with the default settings. diff --git a/pages/dedibox-rpn/how-to/use-rpn-san-proxmox.mdx b/pages/dedibox-rpn/how-to/use-rpn-san-proxmox.mdx index 33d018ed21..ef5969b32a 100644 --- a/pages/dedibox-rpn/how-to/use-rpn-san-proxmox.mdx +++ b/pages/dedibox-rpn/how-to/use-rpn-san-proxmox.mdx @@ -12,8 +12,10 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) diff --git a/pages/dedibox-rpn/how-to/use-rpn-vpn.mdx b/pages/dedibox-rpn/how-to/use-rpn-vpn.mdx index 71a0642b7f..5696cf4e9a 100644 --- a/pages/dedibox-rpn/how-to/use-rpn-vpn.mdx +++ b/pages/dedibox-rpn/how-to/use-rpn-vpn.mdx @@ -12,6 +12,12 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-rpn-vpn-01.webp' +import image2 from './assets/scaleway-rpn-vpn-02.webp' +import image3 from './assets/scaleway-rpn-vpn-03.webp' + The RPN VPN service allows you to access machines inside your RPN from an external connection or from a Dedibox server that does not have an RPN interface. @@ -22,7 +28,7 @@ The RPN VPN service allows you to: * Connect from anywhere in your totally secure and private network. * Connect servers which do not have an RPN interface to the RPN. - + - A Dedibox account logged into the [console](https://console.online.net) - An RPN-compatible [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) @@ -31,15 +37,15 @@ The RPN VPN service allows you to: ## How to download the RPN VPN configuration 1. Click **Storage** > **RPN VPN** in the top menu of the Dedibox console. A summary of your RPN VPN services displays. - + 2. Click **Configure** next to the RPN VPN service you want to configure. The RPN VPN information displays. - + If you do not have any RPN VPN services yet, you can click **Order RPN VPN** directly on the page. 3. Download the certificate files for your RPN VPN. Click **Show Password** to display the password associated with your RPN VPN. - + To use your RPN VPN in your RPNv1 group, you must add it to your group as an RPN server. For more information, follow our [RPN documentation](/dedibox-rpn/quickstart/). diff --git a/pages/dedibox-rpn/quickstart.mdx b/pages/dedibox-rpn/quickstart.mdx index 68e2c12bcb..58ff9704a3 100644 --- a/pages/dedibox-rpn/quickstart.mdx +++ b/pages/dedibox-rpn/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-network --- +import Requirements from '@macros/iam/requirements.mdx' + RPN (Real Private Network) establishes a dedicated, secure connection through your server's secondary network interface. It allows you to seamlessly transfer data among your servers via a controlled, private network. @@ -21,7 +23,7 @@ RPNv2 offers unparalleled flexibility, enabling you to construct your architectu Furthermore, RPN v2 facilitates the configuration of robust security measures to manage your RPN. Segment your infrastructure by creating distinct public and private groups, ensuring that your web server applications are publicly accessible while keeping backend applications secluded from internet access. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](https://www.scaleway.com/en/dedibox) with RPNv2 connectivity diff --git a/pages/dedibox-rpn/reference-content/private-networks-overview.mdx b/pages/dedibox-rpn/reference-content/private-networks-overview.mdx index 4df0a71a50..29fe91853b 100644 --- a/pages/dedibox-rpn/reference-content/private-networks-overview.mdx +++ b/pages/dedibox-rpn/reference-content/private-networks-overview.mdx @@ -11,6 +11,10 @@ dates: categories: - dedibox-network --- +import image from './assets/scaleway-private-networks-table1.webp' +import image2 from './assets/scaleway-private-networks-table2.webp' +import image3 from './assets/scaleway-private-networks-schema.webp' + ## Private Networks between Dedibox and Scaleway cloud products @@ -24,7 +28,7 @@ Scaleway offers solutions to protect your infrastructure, including DDoS protect Scaleway’s ecosystem supports a variety of public cloud services, enabling comprehensive infrastructure building within the cloud. Dedibox offers high-performance dedicated servers for demanding workloads. Both product categories provide distinct private network options: - + ### RPN feature on Scaleway Dedibox @@ -45,7 +49,7 @@ For instance, with six dedicated servers, you can create multiple RPN groups: Servers from different Dedibox accounts can also join an RPN with permission. The **RPNv2** feature supports high bandwidth and real VLANs, making it suitable for tasks like large databases or load balancing. -​ +​ ### Building Private Networks on Scaleway @@ -55,7 +59,7 @@ Instances connected to a Private Network automatically gain a virtual network in Private Networks are also foundational for creating a Virtual Private Cloud (VPC). - + ### Interconnecting services with Virtual Private Networks diff --git a/pages/dedibox-scaleway/how-to/activate-ipv6-block.mdx b/pages/dedibox-scaleway/how-to/activate-ipv6-block.mdx index e354431f20..6ed1de41a6 100644 --- a/pages/dedibox-scaleway/how-to/activate-ipv6-block.mdx +++ b/pages/dedibox-scaleway/how-to/activate-ipv6-block.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-15 posted: 2022-03-24 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/attach-detach-failover-ip.mdx b/pages/dedibox-scaleway/how-to/attach-detach-failover-ip.mdx index 406544e6a1..03856c16b3 100644 --- a/pages/dedibox-scaleway/how-to/attach-detach-failover-ip.mdx +++ b/pages/dedibox-scaleway/how-to/attach-detach-failover-ip.mdx @@ -10,14 +10,20 @@ dates: validation: 2025-04-22 posted: 2022-03-24 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' - +import image from './assets/scaleway-dragndrop-failover-ip.gif' + + + Each failover IP can be routed to any of your Dedibox servers at any time by using the Scaleway console or the API. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -30,7 +36,7 @@ Each failover IP can be routed to any of your Dedibox servers at any time by usi 1. Click **Dedibox** in the **Bare Metal** section of the side menu. 2. Click the **Failover IPs** tab to display a list of your failover IPs. 3. Move your mouse over the failover IP you want to attach to your Dedibox server. Click the IP and drop it on the Dedibox you want to attach it to. - + The routing of your failover IP will be updated. Once the blue dot turns green, your IP is operational, and you can configure it on your machine. diff --git a/pages/dedibox-scaleway/how-to/configure-failover-ip.mdx b/pages/dedibox-scaleway/how-to/configure-failover-ip.mdx index 846ba99f46..0225826f7f 100644 --- a/pages/dedibox-scaleway/how-to/configure-failover-ip.mdx +++ b/pages/dedibox-scaleway/how-to/configure-failover-ip.mdx @@ -10,12 +10,16 @@ dates: validation: 2025-04-30 posted: 2022-04-13 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' - - + - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/configure-ipv6-dedibox.mdx b/pages/dedibox-scaleway/how-to/configure-ipv6-dedibox.mdx index 85070e3b37..d307dad5b6 100644 --- a/pages/dedibox-scaleway/how-to/configure-ipv6-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/configure-ipv6-dedibox.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-22 posted: 2022-04-13 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/configure-reverse-failover-ip.mdx b/pages/dedibox-scaleway/how-to/configure-reverse-failover-ip.mdx index c0d6d86eb1..3049360bf4 100644 --- a/pages/dedibox-scaleway/how-to/configure-reverse-failover-ip.mdx +++ b/pages/dedibox-scaleway/how-to/configure-reverse-failover-ip.mdx @@ -10,12 +10,15 @@ dates: validation: 2025-04-30 posted: 2022-04-13 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - + + You can edit the reverse DNS of a failover IP address to a custom value. This can be useful when you want to send emails from your Dedibox, as certain remote mail servers do not accept emails coming from generic reverse hostnames. - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/connect-to-dedibox.mdx b/pages/dedibox-scaleway/how-to/connect-to-dedibox.mdx index 9c1a2b6c96..8af0648635 100644 --- a/pages/dedibox-scaleway/how-to/connect-to-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/connect-to-dedibox.mdx @@ -10,8 +10,11 @@ dates: validation: 2025-02-24 posted: 2022-01-31 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - + + A common way of connecting to your Dedibox server is via the command line, using SSH. SSH is a secure communication protocol, which imposes an encryption key exchange at the beginning of the connection. This means that the exchange of data between the client and the server will be encrypted. @@ -19,7 +22,7 @@ However, you may also connect to your server via a graphical interface, such as You can also use FTP, SFTP, or SCP to transfer data to and from your server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/install-dedibox.mdx b/pages/dedibox-scaleway/how-to/install-dedibox.mdx index ee87f99835..a880078fd3 100644 --- a/pages/dedibox-scaleway/how-to/install-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/install-dedibox.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-30 posted: 2022-01-31 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/link-dedibox-account.mdx b/pages/dedibox-scaleway/how-to/link-dedibox-account.mdx index aed949b0af..71a183f2ff 100644 --- a/pages/dedibox-scaleway/how-to/link-dedibox-account.mdx +++ b/pages/dedibox-scaleway/how-to/link-dedibox-account.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-06-23 posted: 2022-01-31 --- +import Requirements from '@macros/iam/requirements.mdx' + You can now manage your current and future Dedibox servers from the Scaleway console. This allows you to get the best console experience for your Dedibox servers. @@ -22,7 +24,7 @@ You can now manage your current and future Dedibox servers from the Scaleway con * outsourced services or if you are outsourcing your services - + - A Dedibox account logged into the [console](https://console.online.net) - [Ordered](/dedibox-scaleway/how-to/order-dedibox/) a Dedibox server diff --git a/pages/dedibox-scaleway/how-to/modify-server-options.mdx b/pages/dedibox-scaleway/how-to/modify-server-options.mdx index b7afbc2927..616ccd1491 100644 --- a/pages/dedibox-scaleway/how-to/modify-server-options.mdx +++ b/pages/dedibox-scaleway/how-to/modify-server-options.mdx @@ -10,10 +10,15 @@ dates: validation: 2025-04-22 posted: 2022-04-12 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-modify-options.webp' - + + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +34,7 @@ dates: The public bandwidth option is available for specific Dedibox offers. For a list of compatible machines, see [Additional Bandwidth for your Dedibox](https://www.scaleway.com/en/dedibox/network/bandwidth/). 4. Modify the service level for your Dedibox as required. Based on the service level you can customize your server with additional options, such as storage or DDoS protection. - + 5. A summary of your options and configuration modifications displays. Click **Save changes** to validate. If you order a paid option, the price for the option or customization will be added to your next monthly invoice. diff --git a/pages/dedibox-scaleway/how-to/order-dedibox.mdx b/pages/dedibox-scaleway/how-to/order-dedibox.mdx index 10af14e0cc..e022dadd0c 100644 --- a/pages/dedibox-scaleway/how-to/order-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/order-dedibox.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-22 posted: 2022-01-31 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/order-failover-ip.mdx b/pages/dedibox-scaleway/how-to/order-failover-ip.mdx index b274016c08..5130192c85 100644 --- a/pages/dedibox-scaleway/how-to/order-failover-ip.mdx +++ b/pages/dedibox-scaleway/how-to/order-failover-ip.mdx @@ -10,17 +10,21 @@ dates: validation: 2025-04-22 posted: 2022-03-24 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' +import FailoverIp from '@macros/network/failover-ip-limitations.mdx' - - + + + Failover IP addresses allow you to have several IPs on the same server. You could then, for example, have one IP for each website or virtual machine hosted on the server. Each failover IP can be routed to any of your Dedibox servers at any time in just a few minutes by using the Scaleway console or the API. By switching your failover IP addresses from one server to another, the hosted services remain available without reconfiguring the IP address. Failover IPs can be bought as single IP addresses with a maximum number of IPs per Dedibox server, depending on your offer, or as /27 IP blocks for Dedibox servers with the business service level. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/reinstall-dedibox.mdx b/pages/dedibox-scaleway/how-to/reinstall-dedibox.mdx index 2a623c92f0..469204d64d 100644 --- a/pages/dedibox-scaleway/how-to/reinstall-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/reinstall-dedibox.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-22 posted: 2022-03-24 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/terminate-dedibox.mdx b/pages/dedibox-scaleway/how-to/terminate-dedibox.mdx index d7f57c328c..c4cd981333 100644 --- a/pages/dedibox-scaleway/how-to/terminate-dedibox.mdx +++ b/pages/dedibox-scaleway/how-to/terminate-dedibox.mdx @@ -10,10 +10,13 @@ dates: validation: 2025-04-30 posted: 2022-02-01 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/dedibox-scaleway/how-to/use-rescue-mode.mdx b/pages/dedibox-scaleway/how-to/use-rescue-mode.mdx index 991b1b2162..1fb703b3a5 100644 --- a/pages/dedibox-scaleway/how-to/use-rescue-mode.mdx +++ b/pages/dedibox-scaleway/how-to/use-rescue-mode.mdx @@ -9,8 +9,15 @@ dates: validation: 2025-04-22 posted: 2022-04-12 --- +import DediboxScalewayMigration from '@macros/bare-metal/dedibox-scaleway-migration.mdx' +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-select-rescue.webp' +import image2 from './assets/scaleway-rescue-credentials.webp' +import image3 from './assets/scaleway-normal-mode.webp' + + + This documentation concerns rescue mode for [Dedibox servers](https://www.scaleway.com/en/dedibox/). To use rescue mode on [Instances](https://www.scaleway.com/en/virtual-instances/) refer to the corresponding [documentation](/instances/how-to/use-boot-modes/#how-to-use-rescue-mode). @@ -18,7 +25,7 @@ dates: Rescue mode allows you to boot a [Scaleway Dedibox server](https://www.scaleway.com/en/dedibox/) from the network. It downloads a rescue operating system, that runs completely in the RAM of the server. This allows you to perform maintenance and data recovery operations, even if the machine is not reachable in normal mode. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +38,7 @@ Rescue mode allows you to boot a [Scaleway Dedibox server](https://www.scaleway. 3. Scroll down to the **Rescue Mode** section. 4. Click **Boot in rescue mode.** A pop-up displays. 5. Select the rescue operating system that fits your server's operating system and click **Boot in rescue mode**. - + The server starts to reboot into rescue mode. @@ -46,7 +53,7 @@ Rescue mode allows you to boot a [Scaleway Dedibox server](https://www.scaleway. Rescue mode uses the SSH keys registered for your Dedibox server as an authentication method. If you have lost your private key, you can access your server using the credentials displayed in the console: - + You are now logged into rescue mode and able to perform maintenance actions on the machine. @@ -61,4 +68,4 @@ Once the maintenance of the machine is completed, it can be rebooted back into t To reboot the server into normal mode, click **Switch to normal node** on the server's overview page. The server reboots on the installed system and will be available in normal mode within a few minutes. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/dedibox-scaleway/index.mdx b/pages/dedibox-scaleway/index.mdx index e2dee9a82f..aee37268f5 100644 --- a/pages/dedibox-scaleway/index.mdx +++ b/pages/dedibox-scaleway/index.mdx @@ -49,22 +49,22 @@ meta: ## Tutorials - - - - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -71,7 +74,7 @@ However, you may also connect to your server via a graphical interface, such as You can also use FTP, SFTP, or SCP to transfer data to and from your server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created and uploaded your SSH key](/organizations-and-projects/how-to/create-ssh-key) diff --git a/pages/dedibox-vps/how-to/connect-vps.mdx b/pages/dedibox-vps/how-to/connect-vps.mdx index 03a5065017..c3cbca8dfa 100644 --- a/pages/dedibox-vps/how-to/connect-vps.mdx +++ b/pages/dedibox-vps/how-to/connect-vps.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + You can manage your Dedibox VPS by accessing it through SSH. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created a Dedibox VPS](/dedibox-vps/how-to/create-vps/) diff --git a/pages/dedibox-vps/how-to/create-vps.mdx b/pages/dedibox-vps/how-to/create-vps.mdx index d0435e3a9a..2ce4e6e111 100644 --- a/pages/dedibox-vps/how-to/create-vps.mdx +++ b/pages/dedibox-vps/how-to/create-vps.mdx @@ -12,13 +12,15 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + A Dedibox VPS (Virtual Private Server) is a private virtualized server that operates within a larger physical infrastructure. It provides directly accessible computing resources and greater control of your hosting environment than shared hosting solutions. VPS are suitable for various use cases, including hosting websites, web applications, databases, development environments, etc. They balance performance, control, and affordability for businesses and individuals with moderate to high-traffic websites or applications. - + - A Dedibox account logged into the [console](https://console.online.net) - [Added a payment method](/dedibox-account/how-to/add-payment-method/) to your account diff --git a/pages/dedibox-vps/how-to/delete-vps.mdx b/pages/dedibox-vps/how-to/delete-vps.mdx index 44ea90112b..53e5aecc9f 100644 --- a/pages/dedibox-vps/how-to/delete-vps.mdx +++ b/pages/dedibox-vps/how-to/delete-vps.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + You can delete your VPS by requesting termination from the Dedibox console. To do so, follow these steps. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created a Dedibox VPS](/dedibox-vps/how-to/create-vps/) diff --git a/pages/dedibox-vps/how-to/manage-vps.mdx b/pages/dedibox-vps/how-to/manage-vps.mdx index 052f464be6..38ca96f5c3 100644 --- a/pages/dedibox-vps/how-to/manage-vps.mdx +++ b/pages/dedibox-vps/how-to/manage-vps.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + You can manage your Dedibox VPS directly from the Dedibox console. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created a Dedibox VPS](/dedibox-vps/how-to/create-vps/) diff --git a/pages/dedibox-vps/how-to/reinstall-vps.mdx b/pages/dedibox-vps/how-to/reinstall-vps.mdx index 18bd2c7529..fe3e13d703 100644 --- a/pages/dedibox-vps/how-to/reinstall-vps.mdx +++ b/pages/dedibox-vps/how-to/reinstall-vps.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + You can reinstall your VPS at any time from your Dedibox console. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created a Dedibox VPS](/dedibox-vps/how-to/create-vps/) diff --git a/pages/dedibox-vps/quickstart.mdx b/pages/dedibox-vps/quickstart.mdx index 3326e99048..1161873e7b 100644 --- a/pages/dedibox-vps/quickstart.mdx +++ b/pages/dedibox-vps/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-vps --- +import Requirements from '@macros/iam/requirements.mdx' + A Dedibox VPS (Virtual Private Server) operates within a larger physical infrastructure, providing directly accessible computing resources and greater control than shared hosting solutions. @@ -20,7 +22,7 @@ They offer a balance of performance, control, and affordability for businesses a ## Creating a Dedibox VPS - + - A Dedibox account logged into the [console](https://console.online.net) - [Added a payment method](/dedibox-account/how-to/add-payment-method/) to your account diff --git a/pages/dedibox/how-to/change-root-password.mdx b/pages/dedibox/how-to/change-root-password.mdx index 40689b8fa1..4e869c6628 100644 --- a/pages/dedibox/how-to/change-root-password.mdx +++ b/pages/dedibox/how-to/change-root-password.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + This document shows you how to change your password using the [rescue system](/dedibox/how-to/use-rescue-mode/). If you try to use the usual `passwd` command to change your password, it will only change the password of the rescue system. Your modifications are reset after a reboot. We will show you how to access your real files to change your password. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox/how-to/change-win-server-language.mdx b/pages/dedibox/how-to/change-win-server-language.mdx index 058bda4db2..5cc933e243 100644 --- a/pages/dedibox/how-to/change-win-server-language.mdx +++ b/pages/dedibox/how-to/change-win-server-language.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + This guide provides step-by-step instructions to change the display language of a Windows Server 2019 installation on a Dedibox server. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox server](/dedibox/how-to/order-a-server/) with Windows Server 2019 [installed](/dedibox/how-to/install-a-server/) diff --git a/pages/dedibox/how-to/connect-to-server.mdx b/pages/dedibox/how-to/connect-to-server.mdx index 61ed9f4efc..17cdd44512 100644 --- a/pages/dedibox/how-to/connect-to-server.mdx +++ b/pages/dedibox/how-to/connect-to-server.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + This guide provides instructions on connecting to your Scaleway Dedibox server using SSH (for Linux, macOS, and Windows) or Remote Desktop (for Windows Server). - + - A Dedibox account logged into the [console](https://console.online.net) - [Created and uploaded your SSH key](/dedibox-account/how-to/upload-an-ssh-key/) diff --git a/pages/dedibox/how-to/get-started-with-server.mdx b/pages/dedibox/how-to/get-started-with-server.mdx index 64203ac814..c6bdfc29f3 100644 --- a/pages/dedibox/how-to/get-started-with-server.mdx +++ b/pages/dedibox/how-to/get-started-with-server.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + Once you have set up your Dedibox server, installed an operating system, and connected via SSH, you are ready to begin. This guide provides essential information and tips for efficiently using your Dedibox server. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox/how-to/install-a-server.mdx b/pages/dedibox/how-to/install-a-server.mdx index fd8e7e66f2..969b1159dd 100644 --- a/pages/dedibox/how-to/install-a-server.mdx +++ b/pages/dedibox/how-to/install-a-server.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + After your Scaleway Dedibox server has been delivered, you can proceed with the installation process by following these steps. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox server](/dedibox/how-to/order-a-server/) diff --git a/pages/dedibox/how-to/manage-packages.mdx b/pages/dedibox/how-to/manage-packages.mdx index 086b463779..d3efd05884 100644 --- a/pages/dedibox/how-to/manage-packages.mdx +++ b/pages/dedibox/how-to/manage-packages.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + Packages are archives containing binaries, configuration files, and dependency information for software. A package manager automates software installation, upgrades, and configuration, keeping track of all installed packages and their versions. @@ -21,7 +23,7 @@ This guide covers package management on the following distributions: - CentOS - AlmaLinux - + - A Dedibox account logged into the [console](https://console.online.net) - A [created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) Dedibox server diff --git a/pages/dedibox/how-to/migrate-server.mdx b/pages/dedibox/how-to/migrate-server.mdx index cf130be28e..b76027f197 100644 --- a/pages/dedibox/how-to/migrate-server.mdx +++ b/pages/dedibox/how-to/migrate-server.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + All physical servers eventually reach their End of Life (EOL), but this process is manageable and does not have to disrupt your operations. Hardware vendors provide a warranty and replacement parts for a limited time, usually a few years. @@ -19,7 +21,7 @@ If your Dedibox server approaches EOL, you will see a warning in the console. Rest assured, this guide will walk you through the steps to seamlessly migrate your services and data to a new server, ensuring continuity and minimal downtime. - + - A Dedibox account logged into the [console](https://console.online.net) - A [created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) dedicated server diff --git a/pages/dedibox/how-to/monitor-server.mdx b/pages/dedibox/how-to/monitor-server.mdx index 1babc1d624..3ef6d55b77 100644 --- a/pages/dedibox/how-to/monitor-server.mdx +++ b/pages/dedibox/how-to/monitor-server.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dedibox-monitoring.webp' +import image2 from './assets/scaleway-dedibox-logs.webp' + The monitoring feature is deprecated and **no longer available** from the Dedibox console. For advanced monitoring of your server, refer to Scaleway’s [Observability Cockpit](https://www.scaleway.com/en/cockpit/). @@ -19,7 +24,7 @@ categories: Your management console includes a monitoring system that can notify you by e-mail or SMS when a potential incident or anomaly occurs with your server. In addition, you can also view your server's logs from the console, which shows you a history of past actions carried out on your server. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server @@ -34,7 +39,7 @@ Your management console includes a monitoring system that can notify you by e-ma - Under **Monitoring list**, you can see a list of your current monitoring services. - Under **Add service monitoring**, you can add new monitoring services to your server. - + ### Add a new monitoring service @@ -72,6 +77,6 @@ Viewing your server's logs from the console shows you a list of actions carried 1. From the console, click **Server** > **Server list**. A list of your servers displays. 2. Click **Manage** next to the server you want to monitor. 3. Click **Logs** on the left-side menu. The logs page displays. - + diff --git a/pages/dedibox/how-to/order-a-server.mdx b/pages/dedibox/how-to/order-a-server.mdx index 6f7b209b1c..bf1db6dbe1 100644 --- a/pages/dedibox/how-to/order-a-server.mdx +++ b/pages/dedibox/how-to/order-a-server.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Dedibox](https://www.scaleway.com/en/dedibox/) are our high-quality dedicated servers. With over 15 years of experience, we provide dedicated servers which are recognized for their extreme reliability and best-in-class redundancy. @@ -19,7 +21,7 @@ categories: You can also order Dedibox servers using the [Scaleway console](/dedibox-scaleway/how-to/order-dedibox/), to benefit from the whole Scaleway ecosystem and the latest console. - + - A Dedibox account logged into the [console](https://console.online.net) - Added [a payment method](/dedibox-account/how-to/add-payment-method/) to your account diff --git a/pages/dedibox/how-to/rescue-your-data.mdx b/pages/dedibox/how-to/rescue-your-data.mdx index fb0b3a47d5..5b8f387b37 100644 --- a/pages/dedibox/how-to/rescue-your-data.mdx +++ b/pages/dedibox/how-to/rescue-your-data.mdx @@ -12,10 +12,14 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/sftp.webp' + If your server encounters issues but does not have a hardware failure, you can still recover your data using rescue mode, regardless of whether you are using Windows or Linux. - + - A Dedibox account logged into the [console](https://console.online.net) - A [created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) dedicated server @@ -113,7 +117,7 @@ You can use an SFTP client like [FileZilla](https://filezilla-project.org/) to d #### Example configuration - + Your data will be located in the `/mnt`, `/sda1`, or `/sda` directories. You can download it before reinstalling the server or transferring data to another server. diff --git a/pages/dedibox/how-to/restart-server.mdx b/pages/dedibox/how-to/restart-server.mdx index 7ccf0b2f9d..dfc6029c70 100644 --- a/pages/dedibox/how-to/restart-server.mdx +++ b/pages/dedibox/how-to/restart-server.mdx @@ -12,10 +12,12 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + Your Dedibox server includes a remote reboot system, which we show you how to use in this document. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox/how-to/terminate-dedibox-server.mdx b/pages/dedibox/how-to/terminate-dedibox-server.mdx index 9d4f369133..bfe08130c1 100644 --- a/pages/dedibox/how-to/terminate-dedibox-server.mdx +++ b/pages/dedibox/how-to/terminate-dedibox-server.mdx @@ -12,8 +12,10 @@ dates: categories: - dedibox --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Dedibox account logged into the [console](https://console.online.net) - An active Dedibox server diff --git a/pages/dedibox/how-to/use-dedibackup-ftp-backup.mdx b/pages/dedibox/how-to/use-dedibackup-ftp-backup.mdx index 752945c2fa..912adab2bb 100644 --- a/pages/dedibox/how-to/use-dedibackup-ftp-backup.mdx +++ b/pages/dedibox/how-to/use-dedibackup-ftp-backup.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + Dedibackup is a remote storage solution available for all Dedibox dedicated servers. @@ -26,7 +28,7 @@ The storage system is backed by our [Object Storage](https://www.scaleway.com/en Each offer allows you to store up to 1000 (one thousand) files on your Dedibackup volume. We recommend using archives (tarballs/zip) for your backups. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server diff --git a/pages/dedibox/how-to/use-ipmi-on-server.mdx b/pages/dedibox/how-to/use-ipmi-on-server.mdx index 687681393c..924c229d72 100644 --- a/pages/dedibox/how-to/use-ipmi-on-server.mdx +++ b/pages/dedibox/how-to/use-ipmi-on-server.mdx @@ -12,6 +12,11 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-idrac.webp' +import image2 from './assets/scaleway-ilo.webp' + An **I**ntelligent **P**latform **M**anagement **I**nterface (IPMI) is an industry standard to describe the subsystem of a server providing remote management and monitoring capabilities. IPMI gives you a way to manage and monitor a server even if it is powered off or unresponsive, by using a network connection to the hardware. IPMI is made possible by the **B**aseboard **M**anagement **C**ontroller, an independent piece of hardware connected to your network card, composed of an I2C bus and a dedicated processor. @@ -32,7 +37,7 @@ Actions that can be carried out via IPMI include: In this document, we show you how to access the IPMI for a Dell or HP server. See the [KVM-over-IP](/dedibox-kvm-over-ip/) documentation for information about other server models. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a Dedibox server with a dedicated KVM over IP device @@ -52,7 +57,7 @@ IPMI is a standard specification for a remote management subsystem. On a Dell se The connection URL and your credentials display. Click on the link to access the iDRAC interface. - + 6. Use the interface to monitor and manage your server's hardware: - The **System** tabs let you view various system information including system details, logs, and power status. You can also use the **Console/Media** > **Virtual Media** tab to install your server remotely with a custom OS by connecting virtual media. To launch the KVM, click **Remote Access Controller** under **System Details**. - The **iDDRAC** tabs show you information about the iDRAC itself. @@ -73,7 +78,7 @@ IPMI is a standard specification for a remote management subsystem. On a Dell se The connection URL and your credentials display. Click on the link to access the iLO interface. - + 6. Use the interface to monitor and manage your server's hardware: - The **Information** pages let you view various system information including system details, logs, and diagnostics. - The **Remote Console** pages let you launch the KVM. diff --git a/pages/dedibox/how-to/use-rescue-mode.mdx b/pages/dedibox/how-to/use-rescue-mode.mdx index 68a56bbb01..deab975de7 100644 --- a/pages/dedibox/how-to/use-rescue-mode.mdx +++ b/pages/dedibox/how-to/use-rescue-mode.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + Rescue mode is a minimal operating system that can be booted on demand over the network, allowing you to recover and troubleshoot your server when it fails to boot. Use rescue mode if your Dedibox server: @@ -28,7 +30,7 @@ We offer three types of rescue modes: - [Windows PE](https://learn.microsoft.com/en-us/previous-versions/windows/it-pro/windows-server-2008-R2-and-2008/cc766093(v=ws.10)) - [FreeBSD](https://www.freebsd.org/) - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox server](/dedibox/how-to/order-a-server/) diff --git a/pages/dedibox/how-to/use-serial-console.mdx b/pages/dedibox/how-to/use-serial-console.mdx index 8c2b5aa241..6cae45ae25 100644 --- a/pages/dedibox/how-to/use-serial-console.mdx +++ b/pages/dedibox/how-to/use-serial-console.mdx @@ -12,10 +12,18 @@ dates: categories: - dedibox-servers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-serial-console.webp' +import image2 from './assets/scaleway-serial-console-2.webp' +import image3 from './assets/scaleway-serial-console-esxi.webp' +import image4 from './assets/scaleway-serial-console-esxi2.webp' +import image5 from './assets/scaleway-serial-console-esxi2.webp' + Some Dedibox server models do not have KVM over IP, but allow the visualization of a video output on a serial console. This allows you to interact with the server even if you have locked yourself out, for example by a malicious network configuration. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created](/dedibox/how-to/order-a-server/) and [installed](/dedibox/how-to/install-a-server/) a dedicated server @@ -25,9 +33,9 @@ Some Dedibox server models do not have KVM over IP, but allow the visualization 1. From the console, click **Server** > **Server list** on the top menu. A list of your servers displays. 2. Click **Manage** next to the relevant server. 3. Click **Serial Console**. The connection information displays. - + 4. Click **Access** to access the serial console of your server. - + ## How to configure the serial console @@ -100,7 +108,7 @@ In certain cases, GRUB may not be configured to show the serial console. Directly from the vSphere client: - + 1. Enter the Configuration tab (1). In the **Software** section, click on **Advanced Settings** (2). @@ -109,9 +117,9 @@ Directly from the vSphere client: 3. Click on Boot (1). 4. On the right side of the window, look for the VMKernel.Boot.com2_baud option 5. Enter 9600 (2) as value: - + 6. Look for the VMKernel.Boot.tty2Port value5. Enter 9600 (2) as value: - + 6. Look for the VMKernel.Boot.tty2Port value. 8. Reboot the ESXi host. You can now use the serial console of your server. diff --git a/pages/dedibox/index.mdx b/pages/dedibox/index.mdx index 280a2850d3..a993c1f164 100644 --- a/pages/dedibox/index.mdx +++ b/pages/dedibox/index.mdx @@ -51,22 +51,22 @@ meta: ## Tutorials - - - - + - A Dedibox account logged into the [console](https://console.online.net) - [Added a payment method](/dedibox-account/how-to/add-payment-method/) to your account @@ -108,7 +110,7 @@ However, you may also connect to your server via a graphical interface, such as You can also use FTP, SFTP, or SCP to transfer data to and from your server. - + - A Dedibox account logged into the [console](https://console.online.net) - [Created and uploaded your SSH key](/dedibox-account/how-to/upload-an-ssh-key/) diff --git a/pages/demos/index.mdx b/pages/demos/index.mdx index 73b98a9235..d8ae2e79a6 100644 --- a/pages/demos/index.mdx +++ b/pages/demos/index.mdx @@ -12,20 +12,20 @@ content: description="Take a tour of the Scaleway console with interactive demos. Our step-by-step previews help you explore the interface and discover our products and features." /> -## Getting started with the Scaleway console +## Getting started with the Scaleway console - - - - - -- [Apple silicon: console overview](/apple-silicon/quickstart/#console-overview) -- [Audit Trail: console overview](/audit-trail/quickstart/#console-overview) -- [Billing space: console overview](/billing/quickstart/#console-overview) -- [Block Storage: console overview](/block-storage/quickstart/#console-overview) -- [Container Registry: console overview](/container-registry/quickstart/#console-overview) -- [Containers: console overview](/serverless-containers/quickstart/#console-overview) -- [Elastic Metal: console overview](/elastic-metal/quickstart/#console-overview) -- [Functions: console overview](/serverless-functions/quickstart/#console-overview) -- [IoT Hub: console overview](/iot-hub/quickstart/#console-overview) -- [Jobs: console overview](/serverless-jobs/quickstart/#console-overview) - - -- [Kubernetes: console overview](/kubernetes/quickstart/#console-overview) -- [Local Storage: console overview](/local-storage/quickstart/#console-overview) -- [MongoDB: console overview](/managed-mongodb-databases/quickstart/#console-overview) -- [Object Storage: console overview](/object-storage/quickstart/#console-overview) -- [PostgreSQL and MySQL: console overview](/managed-databases-for-postgresql-and-mysql/quickstart/#console-overview) -- [Redis: console overview](/managed-databases-for-redis/quickstart/#console-overview) -- [Secret Manager: console overview](/secret-manager/quickstart/#console-overview) -- [SQL Databases: console overview](/serverless-sql-databases/quickstart/#console-overview) -- [Topics and Events: console overview](/topics-and-events/quickstart/#console-overview) -- [VPC: console overview](/vpc/quickstart/#console-overview) - - + + + - [Apple silicon: console overview](/apple-silicon/quickstart/#console-overview) + - [Audit Trail: console overview](/audit-trail/quickstart/#console-overview) + - [Billing space: console overview](/billing/quickstart/#console-overview) + - [Block Storage: console overview](/block-storage/quickstart/#console-overview) + - [Container Registry: console overview](/container-registry/quickstart/#console-overview) + - [Containers: console overview](/serverless-containers/quickstart/#console-overview) + - [Elastic Metal: console overview](/elastic-metal/quickstart/#console-overview) + - [Functions: console overview](/serverless-functions/quickstart/#console-overview) + - [IoT Hub: console overview](/iot-hub/quickstart/#console-overview) + - [Jobs: console overview](/serverless-jobs/quickstart/#console-overview) + + + - [Kubernetes: console overview](/kubernetes/quickstart/#console-overview) + - [Local Storage: console overview](/local-storage/quickstart/#console-overview) + - [MongoDB: console overview](/managed-mongodb-databases/quickstart/#console-overview) + - [Object Storage: console overview](/object-storage/quickstart/#console-overview) + - [PostgreSQL and MySQL: console overview](/managed-databases-for-postgresql-and-mysql/quickstart/#console-overview) + - [Redis: console overview](/managed-databases-for-redis/quickstart/#console-overview) + - [Secret Manager: console overview](/secret-manager/quickstart/#console-overview) + - [SQL Databases: console overview](/serverless-sql-databases/quickstart/#console-overview) + - [Topics and Events: console overview](/topics-and-events/quickstart/#console-overview) + - [VPC: console overview](/vpc/quickstart/#console-overview) + + + - + ## Advanced guides - - - + + + + -
- - [How to purchase a savings plan](/billing/how-to/purchase-savings-plan/#purchasing-a-savings-plan) - - [How to add a credit card](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) - - [How to log in as an IAM Member](/iam/how-to/log-in-as-a-member/) - - [How to grant access to the Partner Space](/partner-space/how-to/grant-access-to-partner-space/) - - [How to manage Members](/iam/how-to/manage-members/#interactive-demo) -
+ - [How to purchase a savings plan](/billing/how-to/purchase-savings-plan/#purchasing-a-savings-plan) + - [How to add a credit card](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) + - [How to log in as an IAM Member](/iam/how-to/log-in-as-a-member/) + - [How to grant access to the Partner Space](/partner-space/how-to/grant-access-to-partner-space/) + - [How to manage Members](/iam/how-to/manage-members/#interactive-demo) +
\ No newline at end of file + diff --git a/pages/domains-and-dns/concepts.mdx b/pages/domains-and-dns/concepts.mdx index 58d71ddabc..5815721a03 100644 --- a/pages/domains-and-dns/concepts.mdx +++ b/pages/domains-and-dns/concepts.mdx @@ -11,6 +11,10 @@ dates: categories: - network --- +import image from './assets/scaleway-domain-namespace.webp' +import image2 from './assets/scaleway-dns-nameserver.webp' +import image3 from './assets/scaleway-fqdn.webp' + ## DNS @@ -24,13 +28,13 @@ DNS domains are all organized in a hierarchy called the DNS namespace. The hiera * **Second-level domains**: example.com * **Subdomains**: mysite.example.com or sub.domain.example.com. - + ## DNS name server A DNS name server stores the [DNS Records](#dns-record) for given domains. Scaleway has its own name servers for its managed domains. - + ## DNS record @@ -62,7 +66,7 @@ A fully qualified domain name, also known as **absolute domain**, is a complete An FQDN consists of a [hostname](#hostname), a [subdomain](#subdomain), a domain name comprised of a [second-level-domain](#second-level-domain) and a [top-level domain (TLD)](#top-level-domain-tld), and a **trailing dot**. The trailing dot is used to differentiate fully qualified domain names from [partially qualified domain names](#partially-qualified-domain-name-pqdn) within DNS. - + ## Glue record diff --git a/pages/domains-and-dns/how-to/add-external-domain.mdx b/pages/domains-and-dns/how-to/add-external-domain.mdx index 7e75cf94d5..5e24da6f1a 100644 --- a/pages/domains-and-dns/how-to/add-external-domain.mdx +++ b/pages/domains-and-dns/how-to/add-external-domain.mdx @@ -12,10 +12,15 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dns-ext-domain-estimated-cost.webp' +import image2 from './assets/scaleway-dns-validation-token.webp' + Domains and DNS allows you to manage and register your [internal](/domains-and-dns/concepts/#internal-domain) and [external domains](/domains-and-dns/concepts/#external-domain) and configure and manage their DNS zones. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -23,13 +28,13 @@ Domains and DNS allows you to manage and register your [internal](/domains-and-d 1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. 2. Click the **External domains** tab, then click **+ Manage new domain**. 3. Enter the external domain name in the box and click the search icon to check whether the domain exists. If it does, the estimated cost to add it displays. - + 4. Click **Manage as external**. The instructions to set up your external domain display. Add a `TXT`record to the root zone of the domain at your current registrar to validate the domain ownership. `TXT` means text record. It is used to carry machine-readable data such as information for automated domain validation. Copy the token displayed and create a `TXT` record with the name `_scaleway-challenge` within your current DNS zone as instructed: - + The token's presence will be checked regularly. If it has not been set within 48 hours, the external domain will be deleted from the service. diff --git a/pages/domains-and-dns/how-to/configure-autorenew.mdx b/pages/domains-and-dns/how-to/configure-autorenew.mdx index 475227fdb3..745fded677 100644 --- a/pages/domains-and-dns/how-to/configure-autorenew.mdx +++ b/pages/domains-and-dns/how-to/configure-autorenew.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Autorenew is a feature that allows you to automatically renew the validity period of an internal domain registered with Scaleway Domains and DNS, on a yearly basis. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/configure-dns-zones.mdx b/pages/domains-and-dns/how-to/configure-dns-zones.mdx index 048b5b1949..74438edc12 100644 --- a/pages/domains-and-dns/how-to/configure-dns-zones.mdx +++ b/pages/domains-and-dns/how-to/configure-dns-zones.mdx @@ -12,6 +12,11 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dns-zone-list-edit.webp' +import image2 from './assets/scaleway-dns-edit-zone-name.webp' + A [DNS zone](/domains-and-dns/concepts/#dns-zone) is a distinct part of the [domain namespace](/domains-and-dns/concepts/#dns-namespace) that allows granular control of DNS components. @@ -19,7 +24,7 @@ It contains configuration stored in multiple [DNS records](/domains-and-dns/conc Each **Zone Name** created translates into a [**Domain Name**](/domains-and-dns/concepts/#domain-name). For example, the zone `myzone` in the domain `example.com` becomes `myzone.example.com`. This works also on multiple levels, meaning that the zone `myzone.subdomain` becomes the domain name `myzone.subdomain.example.com`. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -52,9 +57,9 @@ Each **Zone Name** created translates into a [**Domain Name**](/domains-and-dns/ 2. Click the domain for which you want to edit a DNS zone. The domain's **Overview** tab displays. 3. Click the **DNS Zones** tab. A list of the DNS zones you have configured within the selected domain displays. 4. Click , then **Edit name** to edit a zone's name. - + 5. Enter a new name in the pop-up, then click **Edit name** to confirm. - + ## How to delete an existing DNS zone diff --git a/pages/domains-and-dns/how-to/configure-dnssec-internal-domain.mdx b/pages/domains-and-dns/how-to/configure-dnssec-internal-domain.mdx index f1664715ee..586963557c 100644 --- a/pages/domains-and-dns/how-to/configure-dnssec-internal-domain.mdx +++ b/pages/domains-and-dns/how-to/configure-dnssec-internal-domain.mdx @@ -12,12 +12,16 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-dnssec.webp' + DNSSEC uses digital signatures based on public key cryptography to strengthen DNS authentication. You can enable or disable DNSSEC for each of your internal domain names. This page shows you how to enable DNSSEC for your Domains and DNS internal domains only. You can also [enable DNSSEC using the API](https://www.scaleway.com/en/developers/api/domains-and-dns/registrar-api/#path-domains-update-domain-dnssec). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +33,7 @@ This page shows you how to enable DNSSEC for your Domains and DNS internal domai 2. Click the **Internal domains** tab. The list of your internal domains displays. 3. Click the domain name you want to configure. 4. Click **Activate** under **DNSSEC** in the domain information section. - + DNSSEC will be active in a matter of minutes. diff --git a/pages/domains-and-dns/how-to/delete-external-domain.mdx b/pages/domains-and-dns/how-to/delete-external-domain.mdx index bcf95d3a33..12fbc1c73e 100644 --- a/pages/domains-and-dns/how-to/delete-external-domain.mdx +++ b/pages/domains-and-dns/how-to/delete-external-domain.mdx @@ -12,8 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/lock-domain.mdx b/pages/domains-and-dns/how-to/lock-domain.mdx index d2f2326de7..93be5345f8 100644 --- a/pages/domains-and-dns/how-to/lock-domain.mdx +++ b/pages/domains-and-dns/how-to/lock-domain.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to lock your Scaleway Domains and DNS domains to avoid any unsolicited outgoing transfer. Find out how to unlock an internal domain in the [dedicated documentation](/domains-and-dns/how-to/unlock-internal-domain/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/manage-dns-records.mdx b/pages/domains-and-dns/how-to/manage-dns-records.mdx index 413319a993..070ef5965d 100644 --- a/pages/domains-and-dns/how-to/manage-dns-records.mdx +++ b/pages/domains-and-dns/how-to/manage-dns-records.mdx @@ -12,8 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/manage-external-domain.mdx b/pages/domains-and-dns/how-to/manage-external-domain.mdx index 29b7166c0d..86f35795b0 100644 --- a/pages/domains-and-dns/how-to/manage-external-domain.mdx +++ b/pages/domains-and-dns/how-to/manage-external-domain.mdx @@ -12,10 +12,15 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dns-more-info.webp' +import image2 from './assets/scaleway-dns-domain-information.webp' + Once your external domains have been created and validated, you can manage them from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -24,13 +29,13 @@ Once your external domains have been created and validated, you can manage them 1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. 2. Click the **External domains** tab. 3. Click next to the domain you want to manage, then click **More info**. - + A **green** dot displays next to your domain name once it is validated. The domain's **Overview** tab displays. This gives you an overview of the status of your domain, as well as a list of all name servers associated with it. At the bottom of the page, you can also delete your domain from Scaleway Domains and DNS. - + diff --git a/pages/domains-and-dns/how-to/manage-nameservers-internal-domain.mdx b/pages/domains-and-dns/how-to/manage-nameservers-internal-domain.mdx index 802ecae45e..646c575605 100644 --- a/pages/domains-and-dns/how-to/manage-nameservers-internal-domain.mdx +++ b/pages/domains-and-dns/how-to/manage-nameservers-internal-domain.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Domains and DNS provides a managed DNS solution by providing default name servers for each domain name. If you want to use your own DNS servers, you can edit the name servers associated with your domain name. @@ -21,7 +23,7 @@ This is a critical step, especially when configuring [glue records](/domains-and For example, if you own `mydomain.com` and want to use `ns0.mydomain.com` and `ns1.mydomain.com` as your name servers, you must first create A/AAAA records for `ns0` and `ns1` in the `mydomain.com` DNS zone. This links `ns0.mydomain.com` and `ns1.mydomain.com` to their respective IP addresses, making them resolvable. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/register-internal-domain.mdx b/pages/domains-and-dns/how-to/register-internal-domain.mdx index e2c40ecabc..f2092ca21c 100644 --- a/pages/domains-and-dns/how-to/register-internal-domain.mdx +++ b/pages/domains-and-dns/how-to/register-internal-domain.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Domains and DNS allows you to manage and register your [internal](/domains-and-dns/concepts/#internal-domain) and [external domains](/domains-and-dns/concepts/#external-domain) and configure and manage their DNS zones. Domains and DNS provide support for queries via both IPv4 and IPv6. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/how-to/renew-domain.mdx b/pages/domains-and-dns/how-to/renew-domain.mdx index e54f7a4874..6de92bd45e 100644 --- a/pages/domains-and-dns/how-to/renew-domain.mdx +++ b/pages/domains-and-dns/how-to/renew-domain.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domains-and-dns-renew-domain.webp' + This page shows you how to renew your domain using Scaleway Domains and DNS. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -32,7 +36,7 @@ This page shows you how to renew your domain using Scaleway Domains and DNS. 5. Tick the box to confirm you understand your domain will be renewed and that you will be debited the displayed price. - + 6. Click **Renew this domain**. Your domain displays in the **Operations** tab until the renewal is complete. diff --git a/pages/domains-and-dns/how-to/test-dns-zones-with-dig.mdx b/pages/domains-and-dns/how-to/test-dns-zones-with-dig.mdx index f8a7152dd1..6c5ea1e841 100644 --- a/pages/domains-and-dns/how-to/test-dns-zones-with-dig.mdx +++ b/pages/domains-and-dns/how-to/test-dns-zones-with-dig.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + `Dig` or `domain information groper` is a command line tool used to query domain information on [DNS](/domains-and-dns/concepts/#dns) servers. You can use it to troubleshoot DNS issues. @@ -19,7 +21,7 @@ categories: This page shows you how to use the `dig` command to perform some common DNS tests. You do not need to have registered domains with Scaleway Domains and DNS to use this documentation page, but if you are using Scaleway Domains and DNS, refer to the **Before you start** section. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Added](/domains-and-dns/how-to/add-external-domain/) **external domains** with Scaleway Domains and DNS or not diff --git a/pages/domains-and-dns/how-to/trade-domain.mdx b/pages/domains-and-dns/how-to/trade-domain.mdx index 7f2cb65af3..462191809d 100644 --- a/pages/domains-and-dns/how-to/trade-domain.mdx +++ b/pages/domains-and-dns/how-to/trade-domain.mdx @@ -12,12 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Domains and DNS [trade](/domains-and-dns/concepts/#trade) feature allows you to edit your contact information for an internal domain, and update your data from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Entered your credit card information on your account diff --git a/pages/domains-and-dns/how-to/transfer-external-domain.mdx b/pages/domains-and-dns/how-to/transfer-external-domain.mdx index f7305e3b66..64abab2d26 100644 --- a/pages/domains-and-dns/how-to/transfer-external-domain.mdx +++ b/pages/domains-and-dns/how-to/transfer-external-domain.mdx @@ -12,10 +12,15 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-register_new_domain.webp' +import image2 from './assets/scaleway-register_new_domain.webp' + This page shows you how to transfer domains to Scaleway Domains and DNS. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +36,7 @@ This page shows you how to transfer domains to Scaleway Domains and DNS. 1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. The Domains and DNS dashboard displays. 2. Click **+ Register new domain**. - + 3. Enter the domain name you wish to transfer in the box and click the search icon to verify that the domain is available. A selection of available domains displays. 4. Click **Transfer** next to the domain you wish to transfer. A screen displays to help you prepare your transfer. @@ -52,7 +57,7 @@ This page shows you how to transfer domains to Scaleway Domains and DNS. 1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. The Domains and DNS dashboard displays. 2. Click **+ Register new domain**: - + 3. Enter the domain you wish to transfer in the box and click the search icon to verify that the domain is available. A selection of available domains displays. 4. Click **Transfer** next to the domain name you wish to transfer. A screen displays to help you prepare your transfer. diff --git a/pages/domains-and-dns/how-to/unlock-internal-domain.mdx b/pages/domains-and-dns/how-to/unlock-internal-domain.mdx index 49ca5f943d..40e251920a 100644 --- a/pages/domains-and-dns/how-to/unlock-internal-domain.mdx +++ b/pages/domains-and-dns/how-to/unlock-internal-domain.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-domain-unlock.webp' + Domain names are locked by default to avoid any unsolicited outgoing transfer. If you want to transfer your domain to another registrar, you can unlock it from the Scaleway console. @@ -19,7 +23,7 @@ Domain names are locked by default to avoid any unsolicited outgoing transfer. I You cannot unlock internal domains for a period of 60 days after creating them. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -30,7 +34,7 @@ Domain names are locked by default to avoid any unsolicited outgoing transfer. I 1. Click **Domains and DNS** in the **Domains & Web Hosting** section of the [Scaleway console](https://console.scaleway.com) side menu. 2. Click the domain you want to unlock. The domain's **Overview** tab displays. 3. Click **Unlock** under **Transfer** in the **Domain Information** section. A confirmation pop-up displays. - + 4. Click **Unlock** to confirm. The operation might take a few minutes to complete. Once your domain is unlocked, you can copy its transfer authorization code. The transfer authorization code allows you to transfer your domain to another registrar. diff --git a/pages/domains-and-dns/quickstart.mdx b/pages/domains-and-dns/quickstart.mdx index 60e77377fb..79eb82701a 100644 --- a/pages/domains-and-dns/quickstart.mdx +++ b/pages/domains-and-dns/quickstart.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Domains and DNS](https://www.scaleway.com/en/domains-and-dns/) allows you to manage and register your [internal](/domains-and-dns/concepts/#internal-domain) and [external domains](/domains-and-dns/concepts/#external-domain) and configure and manage their DNS zones. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/domains-and-dns/troubleshooting/cannot-transfer-domain.mdx b/pages/domains-and-dns/troubleshooting/cannot-transfer-domain.mdx index 9216885b83..5c897ca3a9 100644 --- a/pages/domains-and-dns/troubleshooting/cannot-transfer-domain.mdx +++ b/pages/domains-and-dns/troubleshooting/cannot-transfer-domain.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to solve domain transfer issues related to **Scaleway Domains and DNS**. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created](/iam/how-to/create-api-keys/) an API key with sufficient [IAM permissions](/iam/reference-content/permission-sets/) to perform the actions described on this page diff --git a/pages/domains-and-dns/troubleshooting/index.mdx b/pages/domains-and-dns/troubleshooting/index.mdx index 0bdf457643..979807acfe 100644 --- a/pages/domains-and-dns/troubleshooting/index.mdx +++ b/pages/domains-and-dns/troubleshooting/index.mdx @@ -20,7 +20,7 @@ productIcon: DomainsProductIcon ## Featured pages - + An Edge Services pipeline consists of an [origin](#origin), which Edge Services can protect from threats with a [Web Application Firefall](#web-application-firewall), and for which it also requests and [caches](#cache) content. Each pipeline also has an [endpoint](#endpoint) from which content is accessed served via Edge Services. The pipeline's endpoint can be customized with a user-defined [subdomain](/domains-and-dns/concepts/#subdomain) and associated [certificate](#certificate) so that Edge Services can serve content over HTTPS. Edge Services can also protect diff --git a/pages/edge-services/faq.mdx b/pages/edge-services/faq.mdx index 87e8adb869..6c5904060e 100644 --- a/pages/edge-services/faq.mdx +++ b/pages/edge-services/faq.mdx @@ -9,6 +9,8 @@ dates: category: network productIcon: EdgeServicesProductIcon --- +import image from './assets/scaleway-edge-services-pipeline.webp' + ## What is Edge Services? @@ -18,7 +20,7 @@ Edge Services is a feature for Scaleway Load Balancers and Object Storage bucket - A [Web Application Firewall](/edge-services/how-to/configure-waf/) to protect your origin from threats and malicious activity, and - A customizable and secure endpoint for accessing content via Edge Services, which can be set to a subdomain of your choice and secured with an SSL/TLS certificate. - + ## Which products are compatible with Edge Services? diff --git a/pages/edge-services/how-to/configure-cache.mdx b/pages/edge-services/how-to/configure-cache.mdx index f0e05434f9..9a154db10e 100644 --- a/pages/edge-services/how-to/configure-cache.mdx +++ b/pages/edge-services/how-to/configure-cache.mdx @@ -12,12 +12,23 @@ tags: object-storage edge-services cdn network cache purge categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-services-lb-dashboard.webp' +import image2 from './assets/scaleway-edge-services-cache.webp' +import image3 from './assets/scaleway-edge-services-lb-dashboard.webp' +import image4 from './assets/scaleway-edge-services-purge-cache.webp' +import image5 from './assets/scaleway-edge-services-lb-dashboard.webp' +import image6 from './assets/scaleway-edge-services-purge-cache.webp' +import image7 from './assets/scaleway-edge-services-purge-object.webp' +import image8 from './assets/scaleway-edge-services-lb-dashboard.webp' + The cache feature allows you to cache your origin's content with Edge Services. This means that content can be served directly to users from Edge Services' servers, instead of from your Object Storage bucket or Load Balancer origin, enhancing performance. You can disable and enable caching at will, as well as control the lifetime of an object in the cache. You can also purge your entire cache, or specific objects within it. A log is displayed to help you track your purge events. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -27,13 +38,13 @@ You can disable and enable caching at will, as well as control the lifetime of a 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage or Load Balancer pipeline on which you want to enable caching: - + 2. In the **Cache** panel, use the icon to enable the cache. The **Lifetime** configuration box displays. This enables you to define, in seconds, how long an object can be stored in the cache before it must be retrieved freshly from the origin (Object Storage bucket or Load Balancer). - + As an example, a value of 0 means that objects will not be cached, unless they have a separately-defined caching directive. Note that in any case, if an object has a caching directive, the caching directive always takes precedence over any lifetime setting defined here in Edge Services. @@ -49,11 +60,11 @@ Purging objects clears all objects from your cache. Afterward, Edge Services wil 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose cache you want to purge: - + 2. In the **Purge cache** panel, click **Purge all**. - + A screen displays, warning you that your cache will be emptied, and Edge Services will have to retrieve objects from your origin before re-caching them. @@ -65,15 +76,15 @@ This allows you to specify the precise objects that you want to clear from the c 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose cache you want to purge: - + 2. In the **Purge cache** panel, click **Purge by object**. - + A screen displays prompting you to enter the path of each object you want to purge from the cache. - + 3. Enter the path of each object you want to purge. You can purge a maximum of 5 objects at a time. @@ -108,7 +119,7 @@ For Object Storage bucket origins, the following example call to the S3 API upda 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose cache you want to disable: - + 2. In the **Cache** panel, use the icon to disable the cache. diff --git a/pages/edge-services/how-to/configure-custom-domain.mdx b/pages/edge-services/how-to/configure-custom-domain.mdx index 2be56c34fe..7bf6ced756 100644 --- a/pages/edge-services/how-to/configure-custom-domain.mdx +++ b/pages/edge-services/how-to/configure-custom-domain.mdx @@ -12,6 +12,13 @@ tags: object-storage edge-services cdn network domain ssl tls https categories: - network --- +import image from './assets/scaleway-edge-services-lb-dashboard.webp' +import image2 from './assets/scaleway-edge-configure-domain.webp' +import image3 from './assets/scaleway-cname-success.webp' +import image4 from './assets/scaleway-edge-services-certificate-complete.webp' +import image5 from './assets/scaleway-edge-services-lb-dashboard.webp' +import image6 from './assets/scaleway-edge-services-lb-dashboard.webp' + If you already own a domain, you can customize an Edge Services pipeline endpoint with a subdomain of your choice. This means you can access your Object Storage bucket or Load Balancer origin through Edge Services via your own subdomain rather than the standardized Edge Services endpoint. @@ -25,11 +32,11 @@ The procedure for adding a customized endpoint is as follows: 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage or Load Balancer pipeline whose domain you want to customize: - + 2. In the **Endpoint** panel, click **Configure domain**. The following screen displays: - + 3. Set a subdomain from which your Object Storage bucket or Load Balancer origin will be accessible via its Edge Services pipeline. You must already own the primary domain. For example, if you own `beautiful-domain.com`, choose any subdomain you like and enter `my-chosen-subdomain.beautiful-domain.com` into the box. @@ -61,7 +68,7 @@ The procedure for adding a customized endpoint is as follows: Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: - + If the check fails, an error message will display. See the documentation linked above for help troubleshooting such errors. Note that it may take a short time for the DNS record to be propagated and the check to pass. @@ -87,7 +94,7 @@ Your customized domain is set up, and you are returned to the Edge Services dash If you chose to generate a managed Let's Encrypt certificate, allow a few minutes for the certificate to finish creating. When the process is complete and the certificate is ready, you will see a green status light for **SSL/TLS certificate** on your endpoint dashboard. - + @@ -97,7 +104,7 @@ After customizing your domain, you can edit it (or its certificate) at any time 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to customize: - + 2. In the **Endpoint** panel, click **Edit**. The **Edit Domain** screen displays. @@ -113,7 +120,7 @@ Even though the original Edge Services endpoint (e.g. `https://pipeline-id.svc.e 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to reset: - + 2. In the **Endpoint** panel, click **Reset**. diff --git a/pages/edge-services/how-to/configure-waf.mdx b/pages/edge-services/how-to/configure-waf.mdx index 1bca5e02cb..1c5f4a01e0 100644 --- a/pages/edge-services/how-to/configure-waf.mdx +++ b/pages/edge-services/how-to/configure-waf.mdx @@ -12,6 +12,12 @@ tags: object-storage edge-services cdn network waf paranoia block exclusions categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-services-lb-dashboard.webp' +import image2 from './assets/scaleway-edge-waf-popup.webp' +import image3 from './assets/scaleway-edge-waf-add-exc.webp' + An Edge Services **W**eb **A**pplication **F**irewall (WAF) evaluates requests to your Load Balancer origin to determine whether they are potentially malicious. You can choose the [paranoia level](/edge-services/concepts/#paranoia-level) to be used when evaluating requests, and set [exclusions](/edge-services/concepts/#exclusions) to define traffic that shouldn't be filtered by WAF. Requests that are judged to be malicious are blocked or logged, depending on the settings you choose. @@ -19,7 +25,7 @@ This page walks you through the process of enabling and configuring WAF to prote To read more about how WAF works, try our [Understanding WAF](/edge-services/reference-content/understanding-waf/) page. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -33,13 +39,13 @@ WAF can be configured via the console for Load Balancer pipelines only. To confi 1. In the Scaleway console, navigate to the Edge Services dashboard for the Load Balancer pipeline on which you want to enable WAF: - + 2. In the **Web Application Firewall (WAF)** panel, click **Enable WAF**. A pop-up displays: - + 3. Choose the **paranoia level**, from 1 - 4, that is best adapted to your use case. The higher the paranoia level, the more sensitive WAF is to potential threats, and the more likely it is to classify a request as malicious. For help with choosing a paranoia level, see our [dedicated documentation](/edge-services/reference-content/understanding-waf/#waf-ruleset-and-paranoia-levels). @@ -67,7 +73,7 @@ Once you have enabled WAF, you can choose to set **exclusions**. Exclusions are The following screen displays: - + 3. Set up to two filters for this exclusion. You can add either: - One ***Path regex** filter, to match paths of requests to exclude. For example, `/api/v1/.*` diff --git a/pages/edge-services/how-to/create-pipeline-bucket.mdx b/pages/edge-services/how-to/create-pipeline-bucket.mdx index efb18f1673..73389f0e3a 100644 --- a/pages/edge-services/how-to/create-pipeline-bucket.mdx +++ b/pages/edge-services/how-to/create-pipeline-bucket.mdx @@ -12,14 +12,19 @@ tags: object-storage edge-services cdn network cache domain https categories: - network --- +import EdgeServicesBucketBenefits from '@macros/edge-services/edge-services-bucket-benefits.mdx' +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-create-pipeline-os.webp' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. Creating an Edge Services pipeline towards your Object Storage bucket brings you a number of possible benefits: - + Read on to learn how to create an Edge Services pipeline for your Object Storage bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -36,7 +41,7 @@ You can create an Edge Services pipeline [from the Object Storage section of the 2. Click **Create pipeline**. The pipeline creation wizard displays. - + 3. Select **Object Storage** as the origin type. diff --git a/pages/edge-services/how-to/create-pipeline-lb.mdx b/pages/edge-services/how-to/create-pipeline-lb.mdx index 2adab2a081..305c32700c 100644 --- a/pages/edge-services/how-to/create-pipeline-lb.mdx +++ b/pages/edge-services/how-to/create-pipeline-lb.mdx @@ -12,12 +12,18 @@ tags: load-balancer edge-services cdn network cache domain https categories: - network --- +import EdgeServicesLbBenefits from '@macros/edge-services/edge-services-lb-benefits.mdx' +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-create-pipeline-lb.webp' +import image2 from './assets/scaleway-edit-edge-lb-pipeline.webp' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -33,7 +39,7 @@ You can create an Edge Services pipeline from the Load Balancer section of the c 1. Click **Edge Services** in the **Network** section of the [Scaleway console](https://console.scaleway.com/) side menu. 2. Click **Create pipeline**. The pipeline creation wizard displays. - + 3. Configure the [origin](/edge-services/concepts/#origin) for this pipeline: - Select **Load Balancer** as the origin type. @@ -116,7 +122,7 @@ You can edit the protocol, origin host, and name of an Edge Services pipeline as 4. In the top right corner, click **Edit**. A pop-up displays. - + 5. Make the edits required. You can: - Change the **protocol** diff --git a/pages/edge-services/how-to/delete-pipeline.mdx b/pages/edge-services/how-to/delete-pipeline.mdx index 24cc381d82..ac8c9b794e 100644 --- a/pages/edge-services/how-to/delete-pipeline.mdx +++ b/pages/edge-services/how-to/delete-pipeline.mdx @@ -12,10 +12,12 @@ tags: load-balancer edge-services cdn network pipeline categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + You can delete an Edge Services pipeline at any time by following the steps below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/edge-services/how-to/monitor-cockpit.mdx b/pages/edge-services/how-to/monitor-cockpit.mdx index 27d11ea24d..9421f00cc1 100644 --- a/pages/edge-services/how-to/monitor-cockpit.mdx +++ b/pages/edge-services/how-to/monitor-cockpit.mdx @@ -12,6 +12,8 @@ tags: load-balancer edge-services cdn cache-hit-ratio grafana observability categories: - network --- +import image from './assets/scaleway-edge-services-metrics.webp' + You can view your Edge Services metrics via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your ingress, egress, request rate, and cache hit ratio as well as other metrics, in a convenient managed Grafana dashboard. @@ -26,7 +28,7 @@ Note that you will first need to [create a Grafana user and credentials](/cockpi The Grafana dashboard presents a number of different metrics. Use the drop-down in the top left to select which pipeline and origin to view Edge Services metrics for, and the time range drop-down in the top right to modify the time period to apply to the metrics. - + - **Request rate**: The number of requests made to Edge Services per second, for the specified origin, averaged over the specified time period. - **Cache hit ratio**: The percentage of requests served from Edge Services' cache, compared to the total number of requests in total to Edge Services for this origin, over the specified time period. diff --git a/pages/edge-services/how-to/subscribe-edge-services.mdx b/pages/edge-services/how-to/subscribe-edge-services.mdx index 7444bef635..49ffd53543 100644 --- a/pages/edge-services/how-to/subscribe-edge-services.mdx +++ b/pages/edge-services/how-to/subscribe-edge-services.mdx @@ -12,6 +12,8 @@ tags: object-storage edge-services subscription-plan subscribe billing pricing categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. It provides: - A [caching service](/edge-services/how-to/configure-cache/) to improve performance by reducing load on your [origin](#origin) @@ -36,7 +38,7 @@ Find out more about how Edge Service subscription plans and billing works on our ## How to subscribe to Edge Services - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/edge-services/how-to/terminate-edge-services.mdx b/pages/edge-services/how-to/terminate-edge-services.mdx index 480523f395..7f726c6040 100644 --- a/pages/edge-services/how-to/terminate-edge-services.mdx +++ b/pages/edge-services/how-to/terminate-edge-services.mdx @@ -12,6 +12,8 @@ tags: object-storage edge-services subscription-plan subscribe billing pricing t categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. It lets you benefit from a powerful caching service to reduce the load on your origin servers and streamline delivery. On top of this, you get a customizable Edge Services endpoint and can set it to a subdomain of your choice, securing it with an SSL/TLS certificate. To use Edge Services, you must subscribe to a monthly plan. @@ -19,7 +21,7 @@ Find out more about how you are charged when you terminate your Edge Services su ## How to terminate your Edge Services subscription - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/edge-services/quickstart.mdx b/pages/edge-services/quickstart.mdx index 43e4b785df..aefe0faa3f 100644 --- a/pages/edge-services/quickstart.mdx +++ b/pages/edge-services/quickstart.mdx @@ -12,6 +12,15 @@ dates: categories: - networks --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-services-pipeline.webp' +import image2 from './assets/scaleway-edge-create-pipeline-lb.webp' +import image3 from './assets/scaleway-edge-create-pipeline-os.webp' +import image4 from './assets/scaleway-edge-services-dashboard.webp' +import image5 from './assets/scaleway-edge-services-configure-domain.webp' +import image6 from './assets/scaleway-cname-success.webp' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. It provides: - A [caching service](/edge-services/how-to/configure-cache/) to improve performance by reducing load on your [origin](#origin) @@ -20,9 +29,9 @@ Edge Services is an additional feature for Scaleway Load Balancers and Object St To use Edge Services, you must take out a subscription plan, which then enables you to create a certain number of Edge Services pipelines towards your Load Balancer origins or Object Storage buckets. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -59,7 +68,7 @@ You can create [pipelines](/edge-services/concepts/#pipeline) for either Object - + 4. Configure the [origin](/edge-services/concepts/#origin) for this pipeline: - Select **Load Balancer** as the origin type. @@ -86,7 +95,7 @@ You can create [pipelines](/edge-services/concepts/#pipeline) for either Object - + 4. Select **Object Storage** as the origin type. @@ -114,11 +123,11 @@ If you already own a domain, you can customize an Edge Services pipeline endpoin 1. In the Scaleway console, navigate to the Edge Services dashboard for the Object Storage bucket or Load Balancer pipeline whose domain you want to customize: - + 2. In the **Endpoint** panel, click **Configure domain**. The following screen displays: - + 3. Set a subdomain from which your Object Storage bucket or Load Balancer origin will be accessible via its Edge Services pipeline. You must already own the primary domain. For example, if you own `beautiful-domain.com`, choose any subdomain you like and enter `my-chosen-subdomain.beautiful-domain.com` into the box. @@ -150,7 +159,7 @@ If you already own a domain, you can customize an Edge Services pipeline endpoin Back in the Scaleway console, click the `Verify CNAME` button to check whether your CNAME record has been correctly configured. Edge Services will carry out a check, and if it is successful the following message displays: - + If the check fails, an error message will display. See the documentation linked above for help troubleshooting such errors. Note that it may take a short time for the DNS record to be propagated and the check to pass. diff --git a/pages/edge-services/reference-content/cname-record.mdx b/pages/edge-services/reference-content/cname-record.mdx index 8d273b86a5..029056b92e 100644 --- a/pages/edge-services/reference-content/cname-record.mdx +++ b/pages/edge-services/reference-content/cname-record.mdx @@ -11,6 +11,8 @@ dates: categories: - network --- +import image from './assets/scaleway-edge-services-configure-domain.webp' + This document contains information to help you successfully create a CNAME record for your customized [Edge Services](/edge-services/) domain, and troubleshoot any potential DNS problems. @@ -37,7 +39,7 @@ However, if you choose to [customize your Edge Services endpoint with your own s - If your domain is managed with [Scaleway Domains and DNS](/domains-and-dns/quickstart/), we take care of auto-generating the appropriate CNAME record for you, as well as deleting it if and when you deactivate Edge Services. There is no action for you to take. You should not attempt to modify or delete the CNAME record (which will be visible among your Domains and DNS records in the console). - If your domain is managed by an external provider, Scaleway is unable to create the appropriate CNAME record for you. You will be prompted, as part of the process for customizing your Edge Services domain, to create this record yourself with your domain provider. - + ## How to create a CNAME record diff --git a/pages/edge-services/reference-content/ssl-tls-certificate.mdx b/pages/edge-services/reference-content/ssl-tls-certificate.mdx index fd3474bbbb..0118f33f3f 100644 --- a/pages/edge-services/reference-content/ssl-tls-certificate.mdx +++ b/pages/edge-services/reference-content/ssl-tls-certificate.mdx @@ -11,6 +11,8 @@ dates: categories: - network --- +import image from './assets/scaleway-cert-expired.webp' + This document contains information to help you with SSL/TLS certificates that enable your origin bucket or Load Balancer content to be served over HTTPS, through your customized [Edge Services](/edge-services/) domain. @@ -174,7 +176,7 @@ When you [configure your customized domain](/edge-services/how-to/configure-cust SSL/TLS certificates all expire at some point. If your certificate expires before you upload a new one, you will see an error like this on your Edge Services dashboard: - + You must renew your certificate or create a new one. A number of tools are available to ensure that certificates are automatically renewed before expiry, for example [Certbot for LetsEncrypt](https://eff-certbot.readthedocs.io/en/stable/using.html#renewing-certificates). However, since Certbot or other tools for automatically renewing certificates are not currently integrated into Edge Services, you will need to manually update the certificate via the Scaleway console. diff --git a/pages/edge-services/reference-content/understanding-pricing.mdx b/pages/edge-services/reference-content/understanding-pricing.mdx index 7f2d4e66e7..5bc5528f0f 100644 --- a/pages/edge-services/reference-content/understanding-pricing.mdx +++ b/pages/edge-services/reference-content/understanding-pricing.mdx @@ -12,6 +12,9 @@ dates: categories: - network --- +import image from './assets/scaleway-current-conso.webp' +import image2 from './assets/scaleway-waf-add-on.webp' + Find out everything you need to know about how Edge Services is billed in this document. @@ -45,7 +48,7 @@ We provide a number of ways to keep track of your Edge Services consumption: - View the details of your current plan, your last monthly invoice, and the costs accumulated so far for Edge Services this month, in the **Plans** tab of your [Edge Services dashboard](https://console.scaleway.com/edge-services) - + - Use [Scaleway Cockpit](/network/edge-services/how-to/monitor-cockpit/) to monitor the data egressing from your Edge Services caches. @@ -55,7 +58,7 @@ The Starter plan is the only plan that does not include WAF. To use WAF on this To add the WAF add-on to your Starter plan, simply [enable WAF](/edge-services/how-to/configure-waf/) on a pipeline. You are then prompted to accept the add-on. You must pay the add-on charge in order to use WAF on the Starter plan. - + This add-on then lets you enable WAF on all your pipelines, and use a fixed amount of WAF requests for that month across all pipelines. Any WAF requests that exceed this amount will be charged additionally, as described below. diff --git a/pages/edge-services/reference-content/understanding-waf.mdx b/pages/edge-services/reference-content/understanding-waf.mdx index fb4c0d06de..58dde3123e 100644 --- a/pages/edge-services/reference-content/understanding-waf.mdx +++ b/pages/edge-services/reference-content/understanding-waf.mdx @@ -12,6 +12,9 @@ dates: categories: - network --- +import image from './assets/scaleway-edge-services-waf-diag.webp' +import image2 from './assets/scaleway-edge-services-pipeline-diag.webp' + You can choose to enable the **W**eb **A**pplication **F**irewall (WAF) feature on your Edge Services pipeline, for added protection. This documentation page gives a detailed overview of WAF, and the different settings, modes and functionalities available. @@ -25,13 +28,13 @@ For requests judged to be malicious, WAF can either block them from passing to y You can set **exclusions**, so that certain requests are not evaluated by WAF and are allowed to pass directly to your origin. Exclusion filters are based on the request path and/or HTTP request type. - + ## WAF in an Edge Services pipeline In an Edge Services pipeline, WAF sits before the origin stage. This means that WAF only protects your origin, it does not protect or filter requests towards the cache. - + If you have both WAF and cache enabled, requests that can be served by the cache will not go through WAF. Only requests that cannot be served by the cache will be filtered by WAF, and allowed to pass to the origin or not depending on your WAF configuration. diff --git a/pages/edge-services/troubleshooting/cname-errors.mdx b/pages/edge-services/troubleshooting/cname-errors.mdx index cbed612301..39c9dcad19 100644 --- a/pages/edge-services/troubleshooting/cname-errors.mdx +++ b/pages/edge-services/troubleshooting/cname-errors.mdx @@ -12,14 +12,17 @@ dates: categories: - network --- +import image from './assets/scaleway-edge-services-cname-error.webp' +import image2 from './assets/scaleway-edge-services-dashboard-error.webp' + When setting up your customized subdomain with Edge Services, you have the option to carry out a verification check on the CNAME record (if your domain is managed with an external provider). Edge Services will query the subdomain and check that it resolves correctly to the Edge Services endpoint. If there is a problem, you will see an error message: - + An error message may also display at a later point from your Edge Services dashboard if a problem is detected at any point with your CNAME record or subdomain: - + The table below helps you resolve these errors: diff --git a/pages/edge-services/troubleshooting/index.mdx b/pages/edge-services/troubleshooting/index.mdx index 98e7b39a81..e0ff8b100b 100644 --- a/pages/edge-services/troubleshooting/index.mdx +++ b/pages/edge-services/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: EdgeServicesProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/api-cli/elastic-metal-with-cli.mdx b/pages/elastic-metal/api-cli/elastic-metal-with-cli.mdx index 45d3880ab4..a4e8cc21ec 100644 --- a/pages/elastic-metal/api-cli/elastic-metal-with-cli.mdx +++ b/pages/elastic-metal/api-cli/elastic-metal-with-cli.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/) provide you with dedicated servers on-demand, with all the benefits of the cloud, including flexibility and hourly billing. These servers are great for large workloads, big data, and applications that require increased security and dedicated resources. You can create and manage your Elastic Metal servers from the [Scaleway console](https://console.scaleway.com/), via the [API](https://www.scaleway.com/en/developers/api/elastic-metal/) or the [Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli#scaleway-cli-v2). @@ -21,7 +23,7 @@ In this tutorial, you will learn how to use the CLI to create an Elastic Metal s The [Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and administer Elastic Metal servers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/concepts.mdx b/pages/elastic-metal/concepts.mdx index 73049e8fac..2f2ce25f21 100644 --- a/pages/elastic-metal/concepts.mdx +++ b/pages/elastic-metal/concepts.mdx @@ -12,6 +12,8 @@ categories: - bare-metal - elastic-metal --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Elastic Metal server @@ -41,7 +43,7 @@ Public IP addresses are routed on the internet. You can enter the public IP addr ## Region and Availability Zone - + ## Remote access diff --git a/pages/elastic-metal/how-to/activate-remote-access.mdx b/pages/elastic-metal/how-to/activate-remote-access.mdx index dcdb1eecb6..69c7009784 100644 --- a/pages/elastic-metal/how-to/activate-remote-access.mdx +++ b/pages/elastic-metal/how-to/activate-remote-access.mdx @@ -12,12 +12,16 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-remote-access-ip.webp' + Remote access is available on most Elastic Metal servers. This option allows you to access the keyboard, video, and mouse of the machine remotely through a KVM-over-IP device. Using remote access, you can access the machine for debugging purposes, even if the installed OS is not working properly. It is also possible to install an Operating System on the machine using a remote ISO file. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -38,7 +42,7 @@ Using remote access, you can access the machine for debugging purposes, even if 4. Read and accept the terms and conditions for the remote access feature. Tick the box to confirm you understood the conditions of the option, then click **Activate**. 5. Enter the [IP address](https://www.whatsmyip.org/) of your internet connection and click **Create access**. - + Make sure to enter the public IP address of your internet connection, as connections to the remote access device are limited to this IP address for security reasons. Currently, only IPv4 addresses are supported by the remote access feature. diff --git a/pages/elastic-metal/how-to/add-virtual-mac-address.mdx b/pages/elastic-metal/how-to/add-virtual-mac-address.mdx index 2b30ef8b09..7b0a276145 100644 --- a/pages/elastic-metal/how-to/add-virtual-mac-address.mdx +++ b/pages/elastic-metal/how-to/add-virtual-mac-address.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Virtual MAC addresses act as virtual interface identifiers necessary for virtualization. When running multiple virtual machines on a single physical Elastic Metal server, you can configure the [MAC address](https://en.wikipedia.org/wiki/MAC_address) of the virtual network interface to match the virtual MAC associated with the [flexible IP](/elastic-metal/concepts/#flexible-ip), ensuring network connectivity for the virtual machine. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/adjust-available-bandwidth.mdx b/pages/elastic-metal/how-to/adjust-available-bandwidth.mdx index 8c662f32fd..75c8c84e9c 100644 --- a/pages/elastic-metal/how-to/adjust-available-bandwidth.mdx +++ b/pages/elastic-metal/how-to/adjust-available-bandwidth.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-01-06 posted: 2024-06-11 --- +import Requirements from '@macros/iam/requirements.mdx' + Every Elastic Metal server comes with a designated bandwidth allowance. Increase your server's connectivity with additional, high-performance bandwidth options of up to 25Gbps, all with unlimited traffic. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/attach-detach-flexible-ip.mdx b/pages/elastic-metal/how-to/attach-detach-flexible-ip.mdx index 0d43f057b1..366a359ac4 100644 --- a/pages/elastic-metal/how-to/attach-detach-flexible-ip.mdx +++ b/pages/elastic-metal/how-to/attach-detach-flexible-ip.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + You can order up to 64 flexible IPs (IPv4 or IPv6) for each of your Elastic Metal servers. These [Elastic Metal flexible IPs](/elastic-metal/concepts/#flexible-ip) can be attached and detached from any of your Elastic Metal servers using the console's drag-and-drop interface. @@ -19,7 +21,7 @@ You can order up to 64 flexible IPs (IPv4 or IPv6) for each of your Elastic Meta Scaleway offers flexible IPs for [Elastic Metal servers](/elastic-metal/concepts/#elastic-metal-server), [Instances](/instances/concepts/#instance), and [Public Gateways](/public-gateways/concepts/#public-gateway). Each set of flexible IPs is independent and can only be used with its respective product. Instance flexible IPs cannot be attached to Elastic Metal servers or Public Gateways, and vice versa. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/elastic-metal/how-to/change-billing-period.mdx b/pages/elastic-metal/how-to/change-billing-period.mdx index 59a3186116..a2fa3eb9ec 100644 --- a/pages/elastic-metal/how-to/change-billing-period.mdx +++ b/pages/elastic-metal/how-to/change-billing-period.mdx @@ -12,12 +12,14 @@ content: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Elastic Metal servers offer flexible billing options to suit your needs. If you are currently using hourly billing, you can upgrade to monthly billing directly from the Scaleway console. By switching to monthly billing, you can benefit from significant discounts compared to the hourly pricing model. This provides you with cost savings for longer-term server rentals and allows you to retain your existing server configuration without requiring a new setup. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Elastic Metal server](/elastic-metal/how-to/create-server/) diff --git a/pages/elastic-metal/how-to/configure-disk-partitions.mdx b/pages/elastic-metal/how-to/configure-disk-partitions.mdx index d999e3bef4..ab345346f1 100644 --- a/pages/elastic-metal/how-to/configure-disk-partitions.mdx +++ b/pages/elastic-metal/how-to/configure-disk-partitions.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Elastic Metal servers come with a default partition layout designed for most users, optimizing installation speed and ease of use. However, if you have specific requirements, you can define a custom partition layout. Partitioning can be configured using either a simplified visual interface or an advanced JSON configuration during server installation. @@ -22,7 +24,7 @@ However, if you have specific requirements, you can define a custom partition la - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/elastic-metal/how-to/configure-flexible-ip.mdx b/pages/elastic-metal/how-to/configure-flexible-ip.mdx index 7faefe5bb4..b49aeb2466 100644 --- a/pages/elastic-metal/how-to/configure-flexible-ip.mdx +++ b/pages/elastic-metal/how-to/configure-flexible-ip.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Learn how to configure a [flexible IP address](/elastic-metal/concepts/#flexible-ip) on your Elastic Metal server. The configuration depends on the Linux distribution running on your machine. You can configure your flexible IP on machines running one of [Ubuntu Linux](#how-to-configure-a-flexible-ip-on-ubuntu-linux), [Debian Linux](#how-to-configure-a-flexible-ip-on-debian-linux) or [CentOS](#how-to-configure-a-flexible-ip-on-centos). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/configure-flexible-ipv6.mdx b/pages/elastic-metal/how-to/configure-flexible-ipv6.mdx index fc194870fd..66c625fae2 100644 --- a/pages/elastic-metal/how-to/configure-flexible-ipv6.mdx +++ b/pages/elastic-metal/how-to/configure-flexible-ipv6.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + The configuration of a flexible IPv6 depends on the Linux distribution running on your Elastic Metal server. This guide covers the steps for configuring your flexible IPv6 on machines running Debian, Ubuntu, or CentOS. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [installed Elastic Metal server](/elastic-metal/quickstart/#how-to-create-an-elastic-metal-server) diff --git a/pages/elastic-metal/how-to/configure-ipv6-hypervisor.mdx b/pages/elastic-metal/how-to/configure-ipv6-hypervisor.mdx index 8fc76c7345..fc562add35 100644 --- a/pages/elastic-metal/how-to/configure-ipv6-hypervisor.mdx +++ b/pages/elastic-metal/how-to/configure-ipv6-hypervisor.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + When you install your server with a virtualization solution like Proxmox, you can create multiple virtual machines on the physical server and configure them to use flexible IPv6 addresses. @@ -21,7 +23,7 @@ This guide covers the steps for configuring the network interfaces on different The DNS cache server (nameserver) may vary depending on the physical location of your server. Refer to our [network information documentation](/account/reference-content/scaleway-network-information/#dns-cache-servers) to find the IPv6 addresses to use with your machine. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/configure-reverse-dns-flexible-ip.mdx b/pages/elastic-metal/how-to/configure-reverse-dns-flexible-ip.mdx index e98b756ae8..fddfb74905 100644 --- a/pages/elastic-metal/how-to/configure-reverse-dns-flexible-ip.mdx +++ b/pages/elastic-metal/how-to/configure-reverse-dns-flexible-ip.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Reverse DNS (rDNS) is the opposite of classic forward DNS, mapping an IP address to a hostname. This is particularly useful for tasks such as sending emails from your Elastic Metal server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/connect-to-server.mdx b/pages/elastic-metal/how-to/connect-to-server.mdx index e5f579721a..04357237aa 100644 --- a/pages/elastic-metal/how-to/connect-to-server.mdx +++ b/pages/elastic-metal/how-to/connect-to-server.mdx @@ -12,10 +12,18 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-putty-main.webp' +import image2 from './assets/scaleway-putty-ssh.webp' +import image3 from './assets/scaleway-putty-security.webp' +import image4 from './assets/scaleway-putty-logged.webp' +import image5 from './assets/scaleway-configuration-page-microsoft-remote.webp' + This page shows you how to connect to your Scaleway Elastic Metal server via SSH. Thanks to the SSH key you created and uploaded, you can use a terminal application on your local computer to remotely connect to your Elastic Metal server as root. This enables you to use your server as you wish. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -53,7 +61,7 @@ To connect to your Elastic Metal server from Windows, you will need to use a sma 1. Download and install PuTTY [here](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) 2. Launch PuTTY on your computer. The main screen of the application displays: - + 3. Enter your Elastic Metal server's IP address in the **Hostname** field. To find the IP address of your Elastic Metal server, log into the Scaleway console and @@ -62,15 +70,15 @@ To connect to your Elastic Metal server from Windows, you will need to use a sma 4. In the side menu, under **Connection**, navigate to the **Auth** sub-category. Do this by expanding **Connection**, then **SSH**, and finally clicking on **Auth**: - + 5. Click the **Browse** button and select the private key file you [generated previously](/organizations-and-projects/how-to/create-ssh-key/). 6. Click **Open** at the bottom of the screen to open a connection to the Elastic Metal server. Upon the first connection, PuTTY asks you to allow the connection to the host. 7. Click **OK** to confirm. - + The terminal window displays. 8. Enter the username `root` and press **Enter** to authenticate against the server with your SSH key. - + You are now connected to your Elastic Metal server. @@ -94,7 +102,7 @@ To connect to your Elastic Metal server running Windows, you need to download a - Microsoft Remote Desktop is not available with Linux. Feel free to use any other remote desktop client to initiate your connection. 3. Click **Add PC**. A configuration page displays. - + 4. Enter your Elastic Metal server's IP address in the **PC name** field and click **Add**. 5. Right-click your newly added PC and select **Connect**. 6. When prompted, enter `Administrateur` in the **Username** field and the password from step 1 in the **Password** field. diff --git a/pages/elastic-metal/how-to/create-server.mdx b/pages/elastic-metal/how-to/create-server.mdx index 984d669305..fdadbda6f7 100644 --- a/pages/elastic-metal/how-to/create-server.mdx +++ b/pages/elastic-metal/how-to/create-server.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/) provide on-demand dedicated servers similar to cloud instances. These servers are ideal for large workloads, big data, and applications requiring enhanced security and dedicated resources. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/elastic-metal/how-to/create-virtual-mac-group.mdx b/pages/elastic-metal/how-to/create-virtual-mac-group.mdx index 42498d51f7..3fd4f9738f 100644 --- a/pages/elastic-metal/how-to/create-virtual-mac-group.mdx +++ b/pages/elastic-metal/how-to/create-virtual-mac-group.mdx @@ -12,12 +12,14 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + If you want to assign multiple flexible IPs to one virtual machine, you can create virtual MAC groups. A virtual MAC group contains at least two flexible IPs that share the same virtual MAC address. Once the virtual MAC group is active, IPs that share the same MAC address are linked together. Moving one IP of the group will automatically move all IPs within the group from one Elastic Metal server to another. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/delete-server.mdx b/pages/elastic-metal/how-to/delete-server.mdx index b76831e9f0..d07570b763 100644 --- a/pages/elastic-metal/how-to/delete-server.mdx +++ b/pages/elastic-metal/how-to/delete-server.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to delete an Elastic Metal server from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/enable-smtp.mdx b/pages/elastic-metal/how-to/enable-smtp.mdx index cc6bfacce8..9c67f364e7 100644 --- a/pages/elastic-metal/how-to/enable-smtp.mdx +++ b/pages/elastic-metal/how-to/enable-smtp.mdx @@ -12,12 +12,16 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-enable-smtp.webp' + By default, the SMTP ports (25, 465, 587) for outgoing emails on your Elastic Metal server are closed and cannot be reached from our infrastructure. If you want to send emails from your server, you can enable SMTP for each Availability Zone from the console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [installed Elastic Metal server](/elastic-metal/quickstart/#how-to-create-an-elastic-metal-server) @@ -34,7 +38,7 @@ If you want to send emails from your server, you can enable SMTP for each Availa You must [verify your identity](/account/how-to/verify-identity/) before you can enable the SMTP ports. 3. Toggle the switch to **ON** beside each Availability Zone for which you want to enable SMTP. - + If SMTP is not available for a specific Availability Zone, the zone will be greyed out. diff --git a/pages/elastic-metal/how-to/get-use-loyalty-reward.mdx b/pages/elastic-metal/how-to/get-use-loyalty-reward.mdx index cb8cf74002..0bec6d8f96 100644 --- a/pages/elastic-metal/how-to/get-use-loyalty-reward.mdx +++ b/pages/elastic-metal/how-to/get-use-loyalty-reward.mdx @@ -12,12 +12,14 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + When you order an Elastic Metal server with monthly billing, you pay a commitment fee to cover the setup cost of your machine. This fee grants you a lower monthly price and gives you the right to receive a loyalty reward if your server is up and running for 12 consecutive months without termination. The value of the reward is a cloud service voucher in the sum of the commitment fees paid at the time of purchase. The voucher is valid for six months, and you can use it for all Scaleway Cloud products except the Bare Metal category (hourly and monthly Elastic Metal, Apple Silicon, and their associated options). You receive the reward once per physical server, and it is automatically added to your Scaleway account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/install-server.mdx b/pages/elastic-metal/how-to/install-server.mdx index bc4fa57048..64aa799c18 100644 --- a/pages/elastic-metal/how-to/install-server.mdx +++ b/pages/elastic-metal/how-to/install-server.mdx @@ -12,12 +12,14 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway [Elastic Metal](https://www.scaleway.com/en/elastic-metal/) allows you to order dedicated servers on-demand, similar to cloud Instances. These servers are ideal for large workloads, big data, and applications requiring enhanced security and dedicated resources. If you ordered your server without a preinstalled operating system, you can install an OS once the Elastic Metal server is delivered to your account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/elastic-metal/how-to/kubernetes-on-riscv.mdx b/pages/elastic-metal/how-to/kubernetes-on-riscv.mdx index db7bf80fcc..c60889226d 100644 --- a/pages/elastic-metal/how-to/kubernetes-on-riscv.mdx +++ b/pages/elastic-metal/how-to/kubernetes-on-riscv.mdx @@ -12,8 +12,10 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/order-flexible-ip.mdx b/pages/elastic-metal/how-to/order-flexible-ip.mdx index 4f4e30bcde..246cfa1b82 100644 --- a/pages/elastic-metal/how-to/order-flexible-ip.mdx +++ b/pages/elastic-metal/how-to/order-flexible-ip.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + [Flexible IP addresses for Elastic Metal servers](/elastic-metal/concepts/#flexible-ip) are additional IP addresses available for [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/). They allow you to move an IP from one server to another without changing your entire configuration. Flexible IPs can also be used as additional IP addresses to create virtual machines on your Elastic Metal server. @@ -20,7 +22,7 @@ They allow you to move an IP from one server to another without changing your en Scaleway offers flexible IPs for [Elastic Metal servers](/elastic-metal/concepts/#elastic-metal-server), [Instances](/instances/concepts/#instance), and [Public Gateways](/public-gateways/concepts/#public-gateway). Each set of flexible IPs is independent and can only be used with its respective product. Instance flexible IPs cannot be attached to Elastic Metal servers or Public Gateways, and vice versa. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/pages/elastic-metal/how-to/reboot-server.mdx b/pages/elastic-metal/how-to/reboot-server.mdx index 3c8df8fd70..17392ca52c 100644 --- a/pages/elastic-metal/how-to/reboot-server.mdx +++ b/pages/elastic-metal/how-to/reboot-server.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + If your [Elastic Metal server](https://www.scaleway.com/en/elastic-metal/) is no longer reachable from the internet or does not work as expected, you can reboot it from the [Scaleway console](https://console.scaleway.com). The reboot feature launches a power-cycle on the physical hardware and restarts the machine. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/reinstall-server.mdx b/pages/elastic-metal/how-to/reinstall-server.mdx index 4117a9ec6a..442581699e 100644 --- a/pages/elastic-metal/how-to/reinstall-server.mdx +++ b/pages/elastic-metal/how-to/reinstall-server.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + An Elastic Metal server can be reinstalled at any time from the [Scaleway console](https://console.scaleway.com). This can be useful when you want to run a different image on the machine or if you want to have a fresh installation. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/send-metrics-logs-to-cockpit.mdx b/pages/elastic-metal/how-to/send-metrics-logs-to-cockpit.mdx index 632b02fa24..de3a06c2a9 100644 --- a/pages/elastic-metal/how-to/send-metrics-logs-to-cockpit.mdx +++ b/pages/elastic-metal/how-to/send-metrics-logs-to-cockpit.mdx @@ -12,12 +12,14 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + Monitoring your dedicated servers with [Scaleway Cockpit](/cockpit/quickstart/) offers detailed information about performance and health, ensuring optimal functionality and proactive issue resolution. Cockpit provides a user-friendly interface for real-time monitoring of CPU, memory, disk usage, and network activity, enhancing the reliability and performance of bare metal servers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/shutdown-server.mdx b/pages/elastic-metal/how-to/shutdown-server.mdx index e162e5ecaf..19619e481f 100644 --- a/pages/elastic-metal/how-to/shutdown-server.mdx +++ b/pages/elastic-metal/how-to/shutdown-server.mdx @@ -12,10 +12,12 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + An Elastic Metal server can be shut down from the [Scaleway console](https://console.scaleway.com). This powers off the physical server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/use-private-networks.mdx b/pages/elastic-metal/how-to/use-private-networks.mdx index 500a80f44e..6caeb24c07 100644 --- a/pages/elastic-metal/how-to/use-private-networks.mdx +++ b/pages/elastic-metal/how-to/use-private-networks.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/vpc/concepts/#private-networks) allow your Elastic Metal servers to communicate in an isolated and secure network without needing to be connected to the public internet. This is an optional-billed feature, available with our Elastic Metal server ranges. @@ -19,7 +21,7 @@ Each server can be connected to one or several Private Networks, letting you bui Private Networks allow your Elastic Metal servers to communicate with other Scaleway resources in an isolated and secure network, without the need of being connected to the public internet. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/how-to/use-rescue-mode.mdx b/pages/elastic-metal/how-to/use-rescue-mode.mdx index fd2d57e347..b650f26507 100644 --- a/pages/elastic-metal/how-to/use-rescue-mode.mdx +++ b/pages/elastic-metal/how-to/use-rescue-mode.mdx @@ -12,6 +12,11 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-elastic-metal-rescue-credentials.webp' +import image2 from './assets/scaleway-bmaas_rescue_mode.webp' + Rescue mode allows you to boot an [Elastic Metal server](https://www.scaleway.com/en/elastic-metal/) from the network. It loads a rescue operating system based on [Ubuntu Linux](https://ubuntu.com/) that runs entirely in the server's RAM. This enables you to perform maintenance and data recovery operations, even if the machine is otherwise unreachable in its normal mode. @@ -19,7 +24,7 @@ Rescue mode allows you to boot an [Elastic Metal server](https://www.scaleway.co This documentation specifically covers rescue mode for [Elastic Metal servers](https://www.scaleway.com/en/elastic-metal/). If you need to use rescue mode on [Instances](https://www.scaleway.com/en/virtual-instances/), please refer to the corresponding [documentation](/instances/how-to/use-boot-modes/#how-to-use-rescue-mode). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -43,7 +48,7 @@ Rescue mode allows you to boot an [Elastic Metal server](https://www.scaleway.co 4. After the server has rebooted, use a terminal application to log into the server via SSH using the credentials provided in your console: - + ``` ssh rescue@ @@ -55,7 +60,7 @@ Rescue mode allows you to boot an [Elastic Metal server](https://www.scaleway.co You are now logged into rescue mode and can perform maintenance tasks on the server. Rescue mode is based on Ubuntu, so you can execute commands as you would on any Ubuntu Linux system. - + Rescue mode runs entirely in the server's RAM. To access files on the hard disk, you need to mount it. diff --git a/pages/elastic-metal/how-to/view-the-event-logs.mdx b/pages/elastic-metal/how-to/view-the-event-logs.mdx index 7c7acde9bd..14b55be4a3 100644 --- a/pages/elastic-metal/how-to/view-the-event-logs.mdx +++ b/pages/elastic-metal/how-to/view-the-event-logs.mdx @@ -12,8 +12,10 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/index.mdx b/pages/elastic-metal/index.mdx index 8104eb2a42..cbd472e131 100644 --- a/pages/elastic-metal/index.mdx +++ b/pages/elastic-metal/index.mdx @@ -48,22 +48,22 @@ meta: ## Tutorials - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/reference-content/elastic-metal-networking.mdx b/pages/elastic-metal/reference-content/elastic-metal-networking.mdx index feaa20d3ab..097f681263 100644 --- a/pages/elastic-metal/reference-content/elastic-metal-networking.mdx +++ b/pages/elastic-metal/reference-content/elastic-metal-networking.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import image from './assets/scaleway-elastic-metal-networking-schema.webp' + Each Scaleway Elastic Metal server is configured with a single physical Network Interface Card (NIC), pre-configured by default. This NIC handles both public internet traffic and private network communication, sharing the total available bandwidth. @@ -19,7 +21,7 @@ Each Scaleway Elastic Metal server is configured with a single physical Network A second physical Network Interface Card (NIC) might be installed in your server, however it is not in use. - + ## Public bandwidth and flexible IPs diff --git a/pages/elastic-metal/reference-content/elastic-metal-rv1-guidelines.mdx b/pages/elastic-metal/reference-content/elastic-metal-rv1-guidelines.mdx index 7381842441..6d3b3865b6 100644 --- a/pages/elastic-metal/reference-content/elastic-metal-rv1-guidelines.mdx +++ b/pages/elastic-metal/reference-content/elastic-metal-rv1-guidelines.mdx @@ -12,6 +12,8 @@ dates: categories: - bare-metal --- +import Requirements from '@macros/iam/requirements.mdx' + ## Boot process @@ -45,7 +47,7 @@ Linux kernel. Mainline Linux is not fully compatible with EM-RV1 servers yet. - + - Installed an EM-RV1 server with Ubuntu - Proficient knowledge of Linux systems @@ -147,7 +149,7 @@ above if you still wish to keep them enabled. This guide will help you get a remote access on the Android distribution installed on your EM-RV1 server. - + - Installed [Android Platform tools](https://developer.android.com/tools/releases/platform-tools) on your diff --git a/pages/elastic-metal/troubleshooting/enable-ssh-virtualization-distribution.mdx b/pages/elastic-metal/troubleshooting/enable-ssh-virtualization-distribution.mdx index ace5e903c7..649dbacdec 100644 --- a/pages/elastic-metal/troubleshooting/enable-ssh-virtualization-distribution.mdx +++ b/pages/elastic-metal/troubleshooting/enable-ssh-virtualization-distribution.mdx @@ -13,6 +13,11 @@ dates: validation: 2025-04-07 posted: 2023-03-09 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-proxmox-permit-ssh.webp' +import image2 from './assets/scaleway_enable_ssh_esxi.webp' + Elastic Metal servers support the installation of virtualization solutions Proxmox and ESXi. These solutions can be managed from either a web interface or a management tool, and therefore direct SSH access to machines running one of these solutions is disabled by default. However, you can enable SSH for advanced management tasks if required. @@ -20,7 +25,7 @@ Elastic Metal servers support the installation of virtualization solutions Proxm Enabling full SSH access to Proxmox or ESXi may cause security vulnerabilities on your installation. Be careful, and take extra precaution when you enable SSH. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [Elastic Metal server](/elastic-metal/quickstart/#how-to-create-an-elastic-metal-server) with Proxmox VE @@ -44,7 +49,7 @@ If you require SSH access to your Elastic Metal server, you can enable SSH on yo PermitRootLogin yes [...] ``` - + 6. Save the file and quit the text editor. 7. Restart the SSH service to enable SSH login. ``` @@ -66,7 +71,7 @@ VMware ESXi is a bare metal hypervisor that allows you to install multiple virtu You can find the URL of the ESXi interface on the overview page of your Elastic Metal server in the Scaleway console. 2. From the **Host** dashboard, click **Actions** > **Services** > **Enable Secure Shell (SSH)**. SSH is enabled. - + 3. Log into your server using SSH. ``` diff --git a/pages/elastic-metal/troubleshooting/index.mdx b/pages/elastic-metal/troubleshooting/index.mdx index 87160adc36..47caef2133 100644 --- a/pages/elastic-metal/troubleshooting/index.mdx +++ b/pages/elastic-metal/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: ElasticMetalProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/troubleshooting/reset-admin-password-windows-server.mdx b/pages/elastic-metal/troubleshooting/reset-admin-password-windows-server.mdx index db758b61dc..86f77e8529 100644 --- a/pages/elastic-metal/troubleshooting/reset-admin-password-windows-server.mdx +++ b/pages/elastic-metal/troubleshooting/reset-admin-password-windows-server.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-01-02 posted: 2023-12-14 --- +import Requirements from '@macros/iam/requirements.mdx' + During the installation or reinstallation of an Elastic Metal server with a Windows Server operating system, an administrator password is set by you (Administrator account). If you have lost this password, you can reset it via rescue mode. This guide explains the steps to securely reset the Administrator password and regain access to your server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/elastic-metal/troubleshooting/troubleshoot-rescue-your-data.mdx b/pages/elastic-metal/troubleshooting/troubleshoot-rescue-your-data.mdx index e2b0feaad8..6408d00bde 100644 --- a/pages/elastic-metal/troubleshooting/troubleshoot-rescue-your-data.mdx +++ b/pages/elastic-metal/troubleshooting/troubleshoot-rescue-your-data.mdx @@ -13,10 +13,12 @@ categories: - bare-metal - elastic-metal --- +import Requirements from '@macros/iam/requirements.mdx' + If your Elastic Metal server encounters issues but does not have a hardware failure, you can still recover your data using rescue mode, regardless of whether you are using Windows or Linux. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created](/elastic-metal/how-to/create-server/) and [installed](/elastic-metal/how-to/install-server/) Elastic Metal server diff --git a/pages/environmental-footprint/additional-content/bare-metal-env-footprint.mdx b/pages/environmental-footprint/additional-content/bare-metal-env-footprint.mdx index 50c590e5bd..996b5b6859 100644 --- a/pages/environmental-footprint/additional-content/bare-metal-env-footprint.mdx +++ b/pages/environmental-footprint/additional-content/bare-metal-env-footprint.mdx @@ -13,6 +13,8 @@ categories: - environmental-footprint - bare-metal --- +import image from './assets/scaleway-allocation-rules-customer-it-equip.webp' + At Scaleway the Bare Metal category includes different types of servers, such as: - Apple silicon servers @@ -29,7 +31,7 @@ For bare metal servers, the allocation of environmental impact is straightforwar The manufacturing impact is prorated based on the server's lifespan and the duration of its use by the customer. By dividing the total manufacturing impact by the expected lifetime of the server and then allocating it according to the specific usage period, we ensure that each user is accountable for their fair share of the server's overall environmental footprint. - + Currently, our calculations for Elastic Metal GPU servers do not include the environmental impact of GPU manufacturing due to insufficient data from the manufacturer. While the impact of CPUs, RAM, disk, and energy consumption is accounted for, the absence of GPU manufacturing data means the figures provided today are underestimated. diff --git a/pages/environmental-footprint/additional-content/environmental-footprint-calculator-estimation.mdx b/pages/environmental-footprint/additional-content/environmental-footprint-calculator-estimation.mdx index 3303e7a773..cd7f977977 100644 --- a/pages/environmental-footprint/additional-content/environmental-footprint-calculator-estimation.mdx +++ b/pages/environmental-footprint/additional-content/environmental-footprint-calculator-estimation.mdx @@ -12,6 +12,10 @@ dates: categories: - environmental-footprint --- +import image from './assets/scaleway-env-impact-estimation-az.webp' +import image2 from './assets/scaleway-select-a-server-env-foot.webp' +import image3 from './assets/scaleway-env-footprint-order-summary.webp' + This feature is currently available on a limited number of products and will soon be extended to all products. Refer to the [Environmental footprint calculator product integration](/environmental-footprint/additional-content/environmental-footprint-integration) index to see which products will integrate the calculator next. @@ -29,7 +33,7 @@ In this page, we use Elastic Metal servers as an example to explain how the esti When you select your Elastic Metal server's Availability Zone, you can see the quantity of CO2 equivalent (CO2e) emitted per kW consumed for each zone. - + This data is determined by the [Power Usage Effectiveness (PUE)](/environmental-footprint/concepts/#pue-power-usage-effectiveness) of the data center and the [energy mix](/environmental-footprint/concepts/#energy-mix) of the country in which the data center is located. @@ -69,7 +73,7 @@ We estimate the measure the server's electricity consumption and then calculate The estimation is represented by three green leaf icons: - + - When the three leaves are dark green, this means that the offer has the lowest environmental impact - When two leaves are dark green, this means that the offer has a low environmental impact @@ -81,4 +85,4 @@ The estimation is represented by three green leaf icons: A summary of the total environmental footprint estimation for the selected offer is shown before the order summary. We also add an indication to help you imagine what this impact is, such as `≈ 35 km by car`. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/environmental-footprint/additional-content/environmental-footprint-calculator.mdx b/pages/environmental-footprint/additional-content/environmental-footprint-calculator.mdx index 0f0a9612b9..05eac03a61 100644 --- a/pages/environmental-footprint/additional-content/environmental-footprint-calculator.mdx +++ b/pages/environmental-footprint/additional-content/environmental-footprint-calculator.mdx @@ -12,6 +12,16 @@ dates: categories: - environmental-footprint --- +import image from './assets/scaleway-overall-env-footprint-calc.webp' +import image2 from './assets/scaleway-focus-on-cross-func-it-equipment.webp' +import image3 from './assets/scaleway-env-footprint-co2eq-formula.webp' +import image4 from './assets/scaleway-allocation-rules-dc-techenv-manuf.webp' +import image5 from './assets/scaleway-allocation-rules-dc-techenv.webp' +import image6 from './assets/scaleway-allocation-rules-network.webp' +import image7 from './assets/scaleway-allocation-rules-customer-it-equip.webp' +import image8 from './assets/scaleway-allocation-rules-cross-funct-it-equip.webp' +import image9 from './assets/scaleway-allocation-rules-non-it-cross-funct.webp' + This feature is currently available on a limited number of products and will soon be extended to all products. Refer to the [Environmental footprint calculator product integration](/environmental-footprint/additional-content/environmental-footprint-integration) index to see which products will integrate the calculator next. @@ -46,12 +56,12 @@ These additional elements cover: By integrating these additional factors into the PCR Data center and cloud methodology, we ensure that our calculations reflect a more complete and transparent view of our environmental impact. - - + + ## Detailed calculation breakdown - + The final calculation of the environmental impact considers several critical factors to provide a thorough and accurate assessment. This includes considering the manufacturing processes for data centers and related technical components, network machines, and servers directly used by customers. Additionally, the assessment accounts for servers dedicated to IT tools and those maintained in stock. @@ -67,7 +77,7 @@ The details of the calculations for each of these elements are detailed below. All calculations will use the following variables: - + The acronyms used below are based on the French phrases for these terms. @@ -86,7 +96,7 @@ All calculations will use the following variables: ### Data center and technical environment - + To calculate the impact of the data center and the technical environment, it is necessary to have either a preliminary study carried out by the hardware suppliers and data center administrators or a quote including all the components. Without such a study, we have chosen to use [ADEME data](https://data.ademe.fr/) to evaluate the impact of the construction of the data center and technical environment (air conditioning and power supply system). @@ -104,7 +114,7 @@ Therefore 0,011 kgCO2e is added to the total manufacturing impact for the use of ### Network - + To calculate the environmental impact of your large-scale use of the products, we include part of the impact of manufacturing the network machines that are necessary for the operation of our products. To do this, we divide the impact of manufacturing network equipment over its entire lifespan and attribute this impact based on the energy consumption of the equipment used in order to assign a proportional share of the environmental impact to each piece of equipment. Finally, we estimate the impact of manufacturing the equipment using the [boavizta database](https://boavizta.org/). @@ -116,7 +126,7 @@ To accurately calculate the environmental impact of each server used directly fo In the calculation pictured below we consider the formula for calculating the customer IT equipment impact allocation for Bare Metal servers. - + Each product will have its own set of criteria to allocate the environmental footprint, considering factors such as server utilization rates, operational timeframes, and the specific technical requirements of the product. By customizing the allocation rules for each offering, we can ensure a more accurate and fair representation of the environmental impact associated with each product. @@ -127,7 +137,7 @@ You can find the calculation specifications for each of the available products i ### Cross-IT equipment & stock - + Our calculation will also incorporate the environmental footprint of all transversal tools essential for the functioning of the Scaleway. @@ -138,7 +148,7 @@ To determine stock manufacturing impact, we will divide the sum of the impact of ### Non-IT cross-functional elements - + Finally, our comprehensive environmental impact calculation will include the "Non-IT cross-functional elements." This category encompasses the environmental footprint of all other essential components required for Scaleway's operations, such as office facilities, employee transportation, the company cafeteria, and various logistical aspects. diff --git a/pages/environmental-footprint/additional-content/instances-env-footprint.mdx b/pages/environmental-footprint/additional-content/instances-env-footprint.mdx index a90c3a7206..40830a25cc 100644 --- a/pages/environmental-footprint/additional-content/instances-env-footprint.mdx +++ b/pages/environmental-footprint/additional-content/instances-env-footprint.mdx @@ -13,6 +13,8 @@ categories: - environmental-footprint - instances --- +import image from './assets/scaleway-allocation-rules-instances.webp' + For Virtual Instances, the calculation of the environmental footprint takes into consideration all the elements described on the [Environmental Footprint calculation breakdown](/environmental-footprint/additional-content/environmental-footprint-calculator/) documentation page. @@ -47,7 +49,7 @@ When calculating an Instance's footprint, we consider the resources based on the - **RAM** - Consider the share of allocated RAM compared to the total RAM of the hypervisor. - **Storage** - Consider the use of allocated storage compared to the total capacity of the hypervisor. - + The value derived from this calculation will be used in every step of the calculation of the Instance's footprint. The variable is represented as `Resources_Used_VM` in the image above. diff --git a/pages/environmental-footprint/how-to/track-monthly-footprint.mdx b/pages/environmental-footprint/how-to/track-monthly-footprint.mdx index 1710c74b24..dcf26cac32 100644 --- a/pages/environmental-footprint/how-to/track-monthly-footprint.mdx +++ b/pages/environmental-footprint/how-to/track-monthly-footprint.mdx @@ -12,8 +12,13 @@ dates: categories: - environmental-footprint --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-env-foot-dashboard.webp' +import image2 from './assets/scaleway-env-monthly-report-detailed.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -23,13 +28,13 @@ categories: 1. Click **Environmental Footprint** in the Organization drop-down menu to go to the **Environmental Footprint Overview** page. The **Environmental Footprint** dashboard appears, displaying the list of your current and past monthly reports. - + 2. Click next to the month for the report you want to download. The monthly report is downloaded to your local computer in PDF format. 3. Open the PDF file. 4. Read through the document, considering the following elements on the page: - + - **1.** The start and end date of the period being tracked (month). - **2.** The name of your Organization. diff --git a/pages/generative-apis/how-to/query-code-models.mdx b/pages/generative-apis/how-to/query-code-models.mdx index b1afac2b56..e5ec4e2a3e 100644 --- a/pages/generative-apis/how-to/query-code-models.mdx +++ b/pages/generative-apis/how-to/query-code-models.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-06-20 posted: 2024-12-09 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Generative APIs service allows users to interact with powerful code models hosted on the platform. @@ -23,7 +25,7 @@ For more information on how to query language models, read [our dedicated docume Code models are also ideal AI assistants when **added to IDEs** (integrated development environments). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/how-to/query-embedding-models.mdx b/pages/generative-apis/how-to/query-embedding-models.mdx index f7bfc76abb..36b53bf531 100644 --- a/pages/generative-apis/how-to/query-embedding-models.mdx +++ b/pages/generative-apis/how-to/query-embedding-models.mdx @@ -10,13 +10,15 @@ dates: validation: 2025-05-12 posted: 2024-08-28 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Generative APIs service allows users to interact with embedding models hosted on the platform. The embedding API provides a simple interface for generating vector representations (embeddings) based on your input data. The embedding service is OpenAI compatible. Refer to OpenAI's [embedding documentation](https://platform.openai.com/docs/api-reference/embeddings) for more detailed information. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/how-to/query-language-models.mdx b/pages/generative-apis/how-to/query-language-models.mdx index 897fa1ae24..5a4f169eae 100644 --- a/pages/generative-apis/how-to/query-language-models.mdx +++ b/pages/generative-apis/how-to/query-language-models.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-05-12 posted: 2024-08-28 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Generative APIs service allows users to interact with powerful language models hosted on the platform. @@ -17,7 +19,7 @@ There are several ways to interact with language models: - The Scaleway [console](https://console.scaleway.com) provides complete [playground](/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time. - Via the [Chat API](/generative-apis/how-to/query-language-models/#querying-language-models-via-api) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/how-to/query-vision-models.mdx b/pages/generative-apis/how-to/query-vision-models.mdx index dc505cc492..7417c5bc61 100644 --- a/pages/generative-apis/how-to/query-vision-models.mdx +++ b/pages/generative-apis/how-to/query-vision-models.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-05-12 posted: 2024-10-30 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Generative APIs service allows users to interact with powerful vision models hosted on the platform. @@ -21,7 +23,7 @@ There are several ways to interact with vision models: - The Scaleway [console](https://console.scaleway.com) provides a complete [playground](/generative-apis/how-to/query-vision-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time. - Via the [Chat API](/generative-apis/how-to/query-vision-models/#querying-vision-models-via-the-api) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/how-to/use-function-calling.mdx b/pages/generative-apis/how-to/use-function-calling.mdx index 9358bf1691..b083ab272a 100644 --- a/pages/generative-apis/how-to/use-function-calling.mdx +++ b/pages/generative-apis/how-to/use-function-calling.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-05-26 posted: 2024-09-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Chat Completions API supports function calling as introduced by OpenAI. @@ -17,7 +19,7 @@ Scaleway's Chat Completions API supports function calling as introduced by OpenA Function calling allows a large language model (LLM) to interact with external tools or APIs, executing specific tasks based on user requests. The LLM identifies the appropriate function, extracts the required parameters, and returns the tool call to be done as structured data, typically in JSON format. While errors can occur, custom parsers or tools like LlamaIndex and LangChain can help ensure valid results. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) for API authentication diff --git a/pages/generative-apis/how-to/use-structured-outputs.mdx b/pages/generative-apis/how-to/use-structured-outputs.mdx index f1fd4ab502..98ccf4034c 100644 --- a/pages/generative-apis/how-to/use-structured-outputs.mdx +++ b/pages/generative-apis/how-to/use-structured-outputs.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-05-12 posted: 2024-09-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Structured outputs allow users to get consistent, machine-readable JSON format responses from language models. @@ -22,7 +24,7 @@ There are several ways to interact with language models: - The Scaleway [console](https://console.scaleway.com) provides a complete [playground](/generative-apis/how-to/query-language-models/#accessing-the-playground), aiming to test models, adapt parameters, and observe how these changes affect the output in real-time. - Via the [Chat API](/generative-apis/how-to/query-language-models/#querying-language-models-via-api) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/quickstart.mdx b/pages/generative-apis/quickstart.mdx index 44712b1488..c00c74753c 100644 --- a/pages/generative-apis/quickstart.mdx +++ b/pages/generative-apis/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + Generative APIs offer seamless access to pre-configured, serverless endpoints of leading AI models. No need to configure hardware or deploy your own models. @@ -22,7 +24,7 @@ Hosted in European data centers and priced competitively per million tokens used This service is free while in beta. [Specific terms and conditions](https://www.scaleway.com/en/contracts/) apply. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/reference-content/adding-ai-to-intellij-using-continue.mdx b/pages/generative-apis/reference-content/adding-ai-to-intellij-using-continue.mdx index 63b6ae1096..07512d4122 100644 --- a/pages/generative-apis/reference-content/adding-ai-to-intellij-using-continue.mdx +++ b/pages/generative-apis/reference-content/adding-ai-to-intellij-using-continue.mdx @@ -10,12 +10,14 @@ dates: validation: 2025-02-14 posted: 2025-02-14 --- +import Requirements from '@macros/iam/requirements.mdx' + AI-driven coding is revolutionizing software development by automating repetitive tasks, generating code snippets, improving code quality, and identifying potential bugs. By integrating AI-powered tools, developers can significantly enhance productivity and optimize workflows. This guide will help you integrate AI-powered code models into JetBrain's IntelliJ IDEA using Continue and Scaleway’s Generative APIs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/reference-content/adding-ai-to-vscode-using-continue.mdx b/pages/generative-apis/reference-content/adding-ai-to-vscode-using-continue.mdx index 60e3f2dc6d..cf5bb4bfc9 100644 --- a/pages/generative-apis/reference-content/adding-ai-to-vscode-using-continue.mdx +++ b/pages/generative-apis/reference-content/adding-ai-to-vscode-using-continue.mdx @@ -10,11 +10,13 @@ dates: validation: 2025-02-14 posted: 2025-02-14 --- +import Requirements from '@macros/iam/requirements.mdx' + AI-powered coding is transforming software development by automating repetitive tasks, generating code, improving code quality, and even detecting and fixing bugs. By integrating AI-driven tools, developers can significantly boost productivity and streamline their workflows. This guide provides a step-by-step guide on how to integrate AI-powered code models into VS Code using Continue and Scaleway's Generative APIs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/reference-content/adding-ai-to-zed-ide.mdx b/pages/generative-apis/reference-content/adding-ai-to-zed-ide.mdx index ee5b51e387..f42261bb14 100644 --- a/pages/generative-apis/reference-content/adding-ai-to-zed-ide.mdx +++ b/pages/generative-apis/reference-content/adding-ai-to-zed-ide.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-03-18 posted: 2025-03-18 --- +import Requirements from '@macros/iam/requirements.mdx' + Zed is an IDE (Integrated Development Environment) including AI coding assistance support. Scaleway's Generative APIs support Zed AI code completion and more. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/generative-apis/troubleshooting/index.mdx b/pages/generative-apis/troubleshooting/index.mdx index 498e47d610..be574b2bb3 100644 --- a/pages/generative-apis/troubleshooting/index.mdx +++ b/pages/generative-apis/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: GenerativeApiProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/gpu/how-to/use-gpu-with-docker.mdx b/pages/gpu/how-to/use-gpu-with-docker.mdx index 9e955c14ec..f49cd21072 100644 --- a/pages/gpu/how-to/use-gpu-with-docker.mdx +++ b/pages/gpu/how-to/use-gpu-with-docker.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Docker is a platform as a service (PaaS) tool that uses OS-level virtualization to deliver applications in packages called containers. Each container is isolated from the others and each of them bundles their own software, libraries, and configuration files. @@ -21,7 +23,7 @@ All [Scaleway GPU Instances](https://www.scaleway.com/en/gpu-instances/) come wi You can also run Docker images provided by other sources and use them with your GPU Instance - for instance, you might want to use Docker images provided by NVIDIA, Google, etc. Alternatively, you could also choose to build your own Docker images. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/gpu/how-to/use-mig-with-kubernetes.mdx b/pages/gpu/how-to/use-mig-with-kubernetes.mdx index 06696d00da..b5fd6ae42e 100644 --- a/pages/gpu/how-to/use-mig-with-kubernetes.mdx +++ b/pages/gpu/how-to/use-mig-with-kubernetes.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + * Scaleway offers MIG-compatible GPU Instances such as H100 PCIe GPU Instances @@ -25,7 +27,7 @@ This technology is particularly valuable in Kubernetes (K8s) environments, where In this guide, we will explore the capabilities of NVIDIA MIG within a Kubernetes cluster. We cover the steps required to set up and configure MIG-enabled GPUs to use with Kubernetes, to maximize GPU usage and ensure workload isolation and performance predictability. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Kubernetes cluster](/kubernetes/quickstart/#how-to-create-a-kubernetes-cluster) with a [GPU Instance](https://www.scaleway.com/en/gpu-instances/) as node diff --git a/pages/gpu/how-to/use-nvidia-mig-technology.mdx b/pages/gpu/how-to/use-nvidia-mig-technology.mdx index 90e23f1169..79cce8f3c3 100644 --- a/pages/gpu/how-to/use-nvidia-mig-technology.mdx +++ b/pages/gpu/how-to/use-nvidia-mig-technology.mdx @@ -12,6 +12,11 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-multi-instance-gpu.webp' +import image2 from './assets/scaleway-jupyter-gpu-instance.webp' + * Scaleway offers MIG-compatible GPU Instances such as H100 PCIe GPU Instances @@ -24,7 +29,7 @@ NVIDIA Multi-Instance GPU (MIG) is a technology introduced by NVIDIA to enhance It allows a single physical GPU to be partitioned into up to seven smaller Instances, each of which operates as an independent MIG partition with its own dedicated resources, such as memory, compute cores, and video outputs. MIG ensures one client cannot impact the work or scheduling of other clients and provides enhanced isolation for customers. - + With MIG, you can see and schedule jobs on virtual MIG partitions as if they were physical GPUs. MIG works with Linux operating systems and containers using Docker Engine, with support for Kubernetes and virtual machines using hypervisors such as Red Hat Virtualization and VMware vSphere. @@ -36,7 +41,7 @@ MIG also provides you with the following benefits: For more information about NVIDIA MIG, refer to the official [MIG documentation](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -300,7 +305,7 @@ Refer to the official documentation for more information about the supported [MI root@my-h100-instance:~# sudo docker run --runtime=nvidia -e NVIDIA_VISIBLE_DEVICES=MIG-da06d78f-7534-56a0-a062-62fef012be9 -p 8888:8888 jupyter/minimal-notebook ``` - + ## How to delete MIG partitions diff --git a/pages/gpu/how-to/use-pipenv.mdx b/pages/gpu/how-to/use-pipenv.mdx index 423ee869fa..244aa1544f 100644 --- a/pages/gpu/how-to/use-pipenv.mdx +++ b/pages/gpu/how-to/use-pipenv.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Pipenv is a powerful package and dependency manager for Python projects. It combines the functionalities of several tools: @@ -22,7 +24,7 @@ Pipenv is a powerful package and dependency manager for Python projects. It comb **Pipenv is preinstalled on all Scaleway AI Docker images for GPU Instances.** When you launch one of these Docker images, you are placed in an activated Pipenv virtual environment with preinstalled packages and tools. You can also create your own virtual environments using Pipenv. - + ### Requirements diff --git a/pages/gpu/how-to/use-preinstalled-env.mdx b/pages/gpu/how-to/use-preinstalled-env.mdx index 86a52c98da..2da904001a 100644 --- a/pages/gpu/how-to/use-preinstalled-env.mdx +++ b/pages/gpu/how-to/use-preinstalled-env.mdx @@ -12,6 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-jupyter-lab.webp' + GPU Instances have different types of preinstalled environments, depending on the OS image you chose during [creation of the Instance](/gpu/how-to/create-manage-gpu-instance/): @@ -21,7 +25,7 @@ GPU Instances have different types of preinstalled environments, depending on th Using the latest Ubuntu Focal GPU OS12 image gives you a minimal OS installation on which you can [launch](/gpu/how-to/use-gpu-with-docker/) one of our ready-made [Docker images](/gpu/reference-content/docker-images/). This gives you access to a preinstalled Python environment managed with pipenv. A number of useful AI core packages and tools are installed, including `scipy`, `numpy`, `scikit-learn`, `jupyter`, `tensorflow`, and the Scaleway SDK. Depending on the [Docker image you choose](/gpu/reference-content/docker-images/), other packages and tools will also be preinstalled, providing a convenient framework environment for you so that you can begin work immediately. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -90,7 +94,7 @@ Some applications, such as [Jupyter Lab](https://jupyter.org/), [Tensorboard](ht Jupyter Lab now displays in your browser. You can use the Notebook, Console, or other features as required: - + You can display the GPU Dashboard in Jupyter Lab to view information about CPU and GPU resource usage. This is accessed via the **System Dashboards** icon on the left side menu (the third icon from the top). 3. Use CTRL+C in the terminal window of your GPU Instance / Docker container to close the Jupyter server when you have finished. diff --git a/pages/gpu/index.mdx b/pages/gpu/index.mdx index 8bdc33e79b..bd13801a09 100644 --- a/pages/gpu/index.mdx +++ b/pages/gpu/index.mdx @@ -48,12 +48,12 @@ meta: ## Tutorials - - +import image from './assets/scaleway-jupyter-lab.webp' + + + Scaleway GPU Instances are virtual compute instances equipped with dedicated high-end Nvidia graphics processing units (GPUs). They are ideal for data processing, artificial intelligence, rendering, and video encoding. After you have created your GPU Instance, you can [connect to it via SSH](/instances/how-to/connect-to-instance/) and run one of our ready-made [Docker images](/gpu/how-to/use-gpu-with-docker/) to access a [preinstalled environment](/gpu/how-to/use-preinstalled-env/) with all your [favorite AI libraries and tools](/gpu/reference-content/docker-images/) preinstalled. @@ -101,7 +105,7 @@ Some applications, such as [Jupyter Lab](https://jupyter.org/), [Tensorboard](ht Jupyter Lab now displays in your browser. You can use the Notebook, Console, or other features as required: - + You can display the GPU Dashboard in Jupyter Lab to view information about CPU and GPU resource usage. This is accessed via the **System Dashboards** icon on the left side menu (third icon from the top). 3. Use CTRL+C in the terminal window of your GPU Instance / Docker container to close down the Jupyter server when you have finished. diff --git a/pages/gpu/troubleshooting/index.mdx b/pages/gpu/troubleshooting/index.mdx index 2a2617360a..32c2980954 100644 --- a/pages/gpu/troubleshooting/index.mdx +++ b/pages/gpu/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: GpuServersProductIcon ## Featured Pages - - - - - - + 5. Click **Launch** ```` @@ -397,11 +406,11 @@ When referring to different aspects of the Scaleway console, use the following t | Console element | Screenshot | |-----------------------------|----------------------------------------------------------------| -| Side menu | | -| Organization drop-down menu | | -| $PRODUCT_NAME dashboard, e.g. Object Storage dashboard | | -| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | | -| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | | +| Side menu | | +| Organization drop-down menu | | +| $PRODUCT_NAME dashboard, e.g. Object Storage dashboard | | +| $PRODUCT_NAME creation page ( NOT `splashscreen`), e.g. Instances creation page | | +| $PRODUCT_NAME creation wizard, e.g. Load Balancer creation wizard | | ### Product and feature names @@ -416,7 +425,7 @@ A wording handbook is available internally, with a full list of correct product Use the [Lightbox component](/components/docs/#lightbox) for images, with the following syntax: ```` - + ```` All images must be in `webp` format, and stored in the page's `assets` folder. Image names must always start with `scaleway`, and the words should be hyphen-seperated. @@ -431,7 +440,7 @@ Blur out any personal information (such as email addresses, telephone numbers, I If you need to refer to different specific parts of a screenshot in the documentation, annotate it with circled letters or numbers in an appropriate [Scaleway brand color](https://ultraviolet.scaleway.com/6dd9b5c45/p/087380-colors--gradients) and [font](https://ultraviolet.scaleway.com/6dd9b5c45/p/484752-fonts): - + ### Diagrams and schemas @@ -487,7 +496,7 @@ The introduction should be a few sentences, or a few short paragraphs, which exp ### Requirements --- - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -496,11 +505,11 @@ The introduction should be a few sentences, or a few short paragraphs, which exp - Installed `helm` (version 3.2+), the Kubernetes [packet manager](https://helm.sh/), on your local machine --- -Start by using the macro `` or type the macro text manually. For example: +Start by using the macro `` or type the macro text manually. For example: | Macro id | Text formatting | |-------------------------------|-----------------| -|`` | ## Before you start

To complete the actions presented below, you must have: | +|`` | ## Before you start

To complete the actions presented below, you must have: | Continue by listing the necessary products, resources or items users must have. Remember to start each item in a way that it forms a coherent sentence when combined with the intro macro (`To complete the actions presented below, you must have: ...`). diff --git a/pages/iam/api-cli/using-api-key-object-storage.mdx b/pages/iam/api-cli/using-api-key-object-storage.mdx index 21cc83b224..e95788eef5 100644 --- a/pages/iam/api-cli/using-api-key-object-storage.mdx +++ b/pages/iam/api-cli/using-api-key-object-storage.mdx @@ -12,11 +12,17 @@ dates: categories: - IAM --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-preferred-project.webp' +import image2 from './assets/scaleway-preferred-project.webp' +import image3 from './assets/scaleway-iam-app.webp' + You can carry out actions on Scaleway Object Storage resources either via the [Scaleway console](https://console.scaleway.com/), or via a third-party API or CLI, such as [the AWS CLI](/object-storage/api-cli/object-storage-aws-cli/), [MinIOClient](/object-storage/api-cli/installing-minio-client/) or [Rclone](/object-storage/api-cli/installing-rclone/). While the Scaleway console gives you the option to specify the [Scaleway Project](#what-is-a-project) to carry out your Object Storage actions in, this option is not available via third-party API/CLI tools. These tools are based on a [standard Amazon S3 programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services), which does not accept Project ID as a parameter. Therefore, when you create a Scaleway API key with IAM, you are prompted to specify the API key's **preferred Project for Object Storage**. This API key will always use this Project when carrying out Object Storage actions via any API/CLI. - + In this document, we explain the concept of preferred Projects for Object Storage, explain how to configure your IAM API key for this, and give some code examples for overriding the preferred Project when making an API call. @@ -55,7 +61,7 @@ Therefore, whenever you perform an action on Object Storage via the API, check t To create an API key via the Scaleway console, follow the steps detailed in [how to create an API key](/iam/how-to/create-api-keys/). During creation, you are asked to select a preferred Project for the API key. A list of your current Projects displays. Choose the required Project for this API key. In the example below, the default project has been chosen: - + While creating an API key, you have the option to skip the step of selecting a preferred Project. Note that if you select this option, the Project that you are currently navigating in the console (i.e. the one that is selected in your [Project dashboard](/organizations-and-projects/concepts/#project-dashboard)) will be automatically selected as the preferred Project for Object Storage. This can still be edited later. @@ -89,13 +95,13 @@ Passing the API access key `SCW2DVV7CZHD8S68YETV@50a526f2-c070-4dca-8f51-fe611a1 In the first part of this example, we create an IAM application, create an API key for that application, and explore the effects that permissions and preferred Project has on our API calls for Object Storage. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to create an IAM application. 1. [Create a new IAM application](/iam/how-to/create-application/) called `my-test-app` without attaching any policies. - + 2. [Create an API key](/iam/how-to/create-api-keys/) for the `my-test-app` application. Select the preferred Project for the API key as `default`. diff --git a/pages/iam/concepts.mdx b/pages/iam/concepts.mdx index 66e958ac48..d2c6d1c86a 100644 --- a/pages/iam/concepts.mdx +++ b/pages/iam/concepts.mdx @@ -9,8 +9,13 @@ tags: advanced settings owner iam principal dates: validation: 2025-04-23 --- +import image from './assets/scaleway-iam-concepts.webp' +import image2 from './assets/scaleway-iam-organization.webp' +import image3 from './assets/scaleway-iam-concepts.webp' +import image4 from './assets/scaleway-iam-policy-example.webp' - + + The diagram above shows how different IAM concepts mentioned on this page interact with one another. @@ -70,7 +75,7 @@ An Organization is made of one or several [Projects](#project). When you create When you create [IAM rules](#rule), you can set their scope at Organization level. This means you can give access to features managed at Organization level, like billing and IAM, to users, applications, and groups in your Organization. - + ## Organization ID @@ -106,7 +111,7 @@ You can carry out actions on Scaleway Object Storage resources either via the [S A principal is the target of a [policy](#policy). They acquire the rights and permissions defined in the policy. A principal can be an [IAM user](#user), an [IAM application](#application) or an [IAM group](#group). Each policy can have a maximum of one principal attached to it. - + ## Project @@ -120,7 +125,7 @@ A Scaleway resource is either a product or a feature in the Scaleway Ecosystem. ## Rule - + A rule (also known as an IAM rule) is the part of a [policy](#policy) that defines the permissions of the policy's [principal](#principal), and the scope of these permissions. A policy can have one or many rules. Each rule consists of: diff --git a/pages/iam/how-to/comply-with-sec-requirements-member.mdx b/pages/iam/how-to/comply-with-sec-requirements-member.mdx index 121a6a48bc..f38d92b404 100644 --- a/pages/iam/how-to/comply-with-sec-requirements-member.mdx +++ b/pages/iam/how-to/comply-with-sec-requirements-member.mdx @@ -9,10 +9,14 @@ dates: validation: 2025-03-24 posted: 2025-03-24 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-member-sec-req.webp' + Upon your [first login as a Member](/iam/how-to/log-in-as-a-member), you must comply with your Organization's security requirements to ensure you can log in without issues in the future. - + - A Scaleway account and logged into the [console](https://console.scaleway.com) as an [IAM Member](/iam/concepts/#member) @@ -25,7 +29,7 @@ Organization administrators may require you to perform two different security ac If one of these requirements is enforced in your Organization, a security checklist will display in your Scaleway console when you log in for the first time, - + The security requirements checklist is only visible to new Members who have not complied with their Organization's security requirements. diff --git a/pages/iam/how-to/create-api-keys.mdx b/pages/iam/how-to/create-api-keys.mdx index c770c3ff45..b04a70100b 100644 --- a/pages/iam/how-to/create-api-keys.mdx +++ b/pages/iam/how-to/create-api-keys.mdx @@ -10,6 +10,12 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-generate-api-key-new.webp' +import image3 from './assets/scaleway-generated-api-key-new.webp' + API keys are unique identifiers necessary to use the [Scaleway API](https://www.scaleway.com/en/developers/api/). You can generate API keys for yourself or for an [IAM application](/iam/concepts/#application) via the Scaleway console. Each API key is scoped to one [Organization](/iam/concepts/#organization) only (so if you are part of multiple Organizations, you will need a different API key for each one). Each user and application can have multiple API keys in each Organization. @@ -24,16 +30,16 @@ API keys always inherit the permissions of their bearer (the IAM user or IAM app If you plan to create API keys that will be used for a long period of time, in production for example, we recommend that you use [applications](/iam/concepts/#application) as the bearers of these API keys. This way, the API keys are linked to non-human users, and are under no risk of leaving or being removed from the Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. You are taken to your [Identity and Access Management dashboard](https://console.scaleway.com/iam/users). - + 2. Click the **API keys** tab. 3. Click **+ Generate API key**. The following screen pops up: - + 4. Select the **bearer** of the API key. Choose between yourself (as an IAM user), or an [IAM application](/iam/concepts/#application) associated with the Organization. 5. Enter an optional **description** for the API key. @@ -55,7 +61,7 @@ API keys always inherit the permissions of their bearer (the IAM user or IAM app 8. Click **Generate API key**. A screen displays showing the access key and secret key for your new API key and reminding you that this is your only chance to securely save the secret key: - + 9. Ensure you have securely saved the secret key, then close the window. You are returned to the **API keys** tab, where your new API key now appears in the list. diff --git a/pages/iam/how-to/create-application.mdx b/pages/iam/how-to/create-application.mdx index 18dec891a3..161198f49d 100644 --- a/pages/iam/how-to/create-application.mdx +++ b/pages/iam/how-to/create-application.mdx @@ -9,20 +9,26 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-iam-applications.webp' +import image3 from './assets/scaleway-iam-create-app.webp' + An IAM application is a non-human user in an [Organization](/iam/concepts/#organization). This feature lets you create API keys that are not linked to a specific user, to give programmatic access to resources and make your production code more robust. As with users, you can define permissions and access rights for each IAM application via policies. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Applications** tab. A list of the Organization's existing IAM applications displays: - + 3. Click [Create application](https://console.scaleway.com/iam/applications/create). The creation wizard displays: - + 4. Complete the steps of the creation wizard: - Enter a name for the application, or use the auto-generated name suggested for you, - Add a tag (optional), diff --git a/pages/iam/how-to/create-group.mdx b/pages/iam/how-to/create-group.mdx index 6082bc1f60..7cfa471ffa 100644 --- a/pages/iam/how-to/create-group.mdx +++ b/pages/iam/how-to/create-group.mdx @@ -9,20 +9,26 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-groups-overview.webp' +import image3 from './assets/scaleway-create-group.webp' + An IAM group is a grouping of users and/or applications. Groups allow you to attach [policies](/iam/concepts/#policy) to multiple users at the same time. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Groups** tab. A list of the Organization's existing IAM groups displays: - + 3. Click **+ Create group**. The group creation wizard displays: - + 4. Complete the steps of the creation wizard: - Enter a **name** for the group, or use the auto-generated name suggested for you, - Add a tag (optional), diff --git a/pages/iam/how-to/create-policy.mdx b/pages/iam/how-to/create-policy.mdx index 79f72306f5..14bdb8a4c3 100644 --- a/pages/iam/how-to/create-policy.mdx +++ b/pages/iam/how-to/create-policy.mdx @@ -9,22 +9,30 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-policy.webp' +import image2 from './assets/scaleway-iam-users-dashboard.webp' +import image3 from './assets/scaleway-iam-policies.webp' +import image4 from './assets/scaleway-iam-create-policy-1.webp' +import image5 from './assets/scaleway-iam-create-policy-2.webp' + An IAM [policy](/iam/reference-content/policy/) is used to define the permissions of users, groups, and applications in a given [Organization](/iam/concepts/#organization). A policy is composed of a **principal** (the user, group, or application to which it applies) and one or more **IAM rules** (which describe the permission sets the principal should have, and the scope of those permission sets). - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Policies** tab. A list of the Organization's existing policies displays: - + 3. Click **Create policy**. The creation wizard displays: - + 4. Complete the steps on the first page of the creation wizard: - Enter a **name** for the policy, - Add a tag (optional), @@ -40,7 +48,7 @@ An IAM [policy](/iam/reference-content/policy/) is used to define the permission You can choose to create a policy without a principal for now, and attach the principal later. Be aware that the policy will have no effect until a principal is attached. A policy can only be attached to one principal at a time. 5. Click **Add rules** to progress to the next part of the policy creation wizard. - + Rules define the actions that the attached principal will be able to carry out within the Organization. When creating a rule, you first set the **scope** of the rule, and then select the **permission sets** to apply within the scope. You can optionally set up **conditions** for your rule. See our dedicated documentation for more help with [policies, rules, scopes and permission sets](/iam/reference-content/policy/). diff --git a/pages/iam/how-to/enforce-security-requirements-members.mdx b/pages/iam/how-to/enforce-security-requirements-members.mdx index f1a021e1f8..58ec395c84 100644 --- a/pages/iam/how-to/enforce-security-requirements-members.mdx +++ b/pages/iam/how-to/enforce-security-requirements-members.mdx @@ -11,6 +11,8 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + For the increased security of your Organization, you can enforce different security measures for your IAM members. @@ -18,7 +20,7 @@ For the increased security of your Organization, you can enforce different secur The security measures listed on this page, except enforcing MFA, apply only to [IAM members](/iam/concepts#members). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iam/how-to/log-in-as-a-member.mdx b/pages/iam/how-to/log-in-as-a-member.mdx index fc491827ad..3642befa33 100644 --- a/pages/iam/how-to/log-in-as-a-member.mdx +++ b/pages/iam/how-to/log-in-as-a-member.mdx @@ -9,6 +9,8 @@ dates: validation: 2025-04-30 posted: 2025-03-26 --- +import LoginMember from '@macros/iam/login-member.mdx' + When you are added to a Scaleway Organization, you become its Member. To access it, you must complete a dedicated login process and may be required to comply with your Organization's security requirements. @@ -16,7 +18,7 @@ Learn how to do so by following our guided tour or reading the instructions belo - + diff --git a/pages/iam/how-to/manage-api-keys.mdx b/pages/iam/how-to/manage-api-keys.mdx index 1638abce48..6e9546ab7c 100644 --- a/pages/iam/how-to/manage-api-keys.mdx +++ b/pages/iam/how-to/manage-api-keys.mdx @@ -9,21 +9,27 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-edit-api-key.webp' +import image3 from './assets/scaleway-iam-users-dashboard.webp' + All users are able to view and delete their own API keys as necessary. API keys can also be edited, to change the description or [preferred Project](/iam/api-cli/using-api-key-object-storage/). Instructions for these actions are given below. If you are the Owner of your Organization, or have [sufficient permissions](/iam/reference-content/permission-sets/) to do so, you can also view, edit and delete the API keys of other IAM users / applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) ## How to edit an API key 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. You are taken to your [Identity and Access Management dashboard](https://console.scaleway.com/iam/users). - + 2. Click the **API keys** tab. 3. Click the icon next to the API key you want to edit, and select **Edit**. The following screen displays: - + 4. Edit the API key as required: - Edit the **description**, and/or @@ -33,7 +39,7 @@ All users are able to view and delete their own API keys as necessary. API keys ## How to delete an API key 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. You are taken to your [Identity and Access Management dashboard](https://console.scaleway.com/iam/users). - + 2. Click the **API keys** tab. 3. Click the icon next to the API key you want to edit, and select **Delete**. diff --git a/pages/iam/how-to/manage-applications.mdx b/pages/iam/how-to/manage-applications.mdx index ca5d04072d..1af09b6cb3 100644 --- a/pages/iam/how-to/manage-applications.mdx +++ b/pages/iam/how-to/manage-applications.mdx @@ -9,10 +9,16 @@ dates: validation: 2025-01-06 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-iam-applications.webp' +import image3 from './assets/scaleway-delete-application-popup.webp' + You can manage IAM applications in an Organization if you are the [Owner](/iam/concepts/#owner) of that Organization, or if you have sufficient permissions (via [policies](/iam/concepts/#policy)) to do so. Management actions including adding and removing IAM applications to/from groups, attaching and detaching policies to/from applications, generating, viewing and deleting applications' API keys and deleting applications from the Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -20,7 +26,7 @@ You can manage IAM applications in an Organization if you are the [Owner](/iam/c ## How to access the application overview 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Applications** tab. A list of the Organization's IAM applications displays. 3. Click the name of the application you want to manage. Alternatively, click next to the application, and select **Overview**. Either way, you are taken to the application's **Overview** tab. Follow the steps below depending on the management action you wish to take. @@ -31,7 +37,7 @@ From the application's [Overview tab](#how-to-access-the-application-overview), On this page you can also find an extensive list of the application's permission sets, the name of their associated policies and the scope they apply to. - + ## How to manage an application's groups @@ -111,7 +117,7 @@ The API key is edited, and you are returned to the list of API keys. 1. From the application's [**Overview** tab](#how-to-access-the-application-overview), scroll down to the **Delete application** panel. 2. Click **Delete application**. A warning displays, asking you to confirm your action: - + 3. Type **DELETE** to confirm, and click **Delete application** to validate. diff --git a/pages/iam/how-to/manage-groups.mdx b/pages/iam/how-to/manage-groups.mdx index 0dc5a2ff06..14d4471b8f 100644 --- a/pages/iam/how-to/manage-groups.mdx +++ b/pages/iam/how-to/manage-groups.mdx @@ -9,10 +9,17 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-groups-overview.webp' +import image3 from './assets/scaleway-add-user-to-group.webp' +import image4 from './assets/scaleway-delete-group.webp' + You can manage IAM groups in an Organization if you are the [Owner](/iam/concepts/#owner) of that Organization, or if you have sufficient permissions (via [policies](/iam/concepts/#policy)) to do so. Management actions include adding and removing members to groups, attaching and detaching policies to/from groups and deleting groups from the Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -20,9 +27,9 @@ You can manage IAM groups in an Organization if you are the [Owner](/iam/concept ## How to access the group overview 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Groups** tab. A list of the Organization's IAM groups displays. - + 3. Click the name of the group you want to manage. Alternatively, click next to the application, and select **Overview**. Either way, you are taken to the group's **Overview** page. Follow the steps below depending on the management action you wish to take. @@ -38,7 +45,7 @@ From the groups's [Overview page](#how-to-access-the-group-overview), scroll dow ### Add users to a group 1. In the **Users** panel, click **Add users**. A pop-up displays: - + 2. Select the user you want to add from the drop-down menu, or type the name of the user. 3. Click **Validate**. You are returned to the group's overview page, where the newly-added user now appears. @@ -97,7 +104,7 @@ A group may be attached to multiple policies. 1. From the groups's [**Overview** tab](#how-to-access-the-group-overview), scroll down to the **Delete group** panel. 2. Click **Delete group**. A warning displays, asking you to confirm your action: - + 3. Type **DELETE** to confirm, and click **Delete group** to validate. diff --git a/pages/iam/how-to/manage-members.mdx b/pages/iam/how-to/manage-members.mdx index 551b675eaa..617c4354f1 100644 --- a/pages/iam/how-to/manage-members.mdx +++ b/pages/iam/how-to/manage-members.mdx @@ -9,8 +9,13 @@ dates: validation: 2025-06-16 posted: 2025-03-26 --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-user-info.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -47,7 +52,7 @@ Watch our interactive demo for a visual guide on how to manage IAM Members on th ## How to access the Member overview 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the name of the user you want to manage. Alternatively, click next to the user, and select **Overview**. Either way, you are taken to the user's **Overview** tab. Follow the steps below depending on the management action you wish to take. @@ -58,7 +63,7 @@ From the user's [Overview tab](#how-to-access-the-user-overview), you can view i - **User details** - The user's type (Owner or Member), status, **created on** date, whether they have [MFA](/account/concepts/#multifactor-authentication-mfa) enabled, and the date of their last login. - **User profile** - The user's username, first and last names, email address, telephone number, preferred language, and their Scaleway ID number. - + In the Overview tab, you can also find an extensive list of the user's permission sets, the name of their associated policies and the scope they apply to. diff --git a/pages/iam/how-to/manage-policies.mdx b/pages/iam/how-to/manage-policies.mdx index d6ddbf75f8..e1f8ba6f52 100644 --- a/pages/iam/how-to/manage-policies.mdx +++ b/pages/iam/how-to/manage-policies.mdx @@ -9,10 +9,16 @@ dates: validation: 2025-01-02 posted: 2022-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' +import image2 from './assets/scaleway-iam-policies.webp' +import image3 from './assets/scaleway-policy-overview.webp' + You can manage IAM [policies](/iam/concepts/#policy) in an Organization if you are the [Owner](/iam/concepts/#owner) of that Organization, or if you have sufficient permissions (via existing policies) to do so. Management actions including editing, attaching and detaching policies to/from groups and deleting groups from the Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -20,9 +26,9 @@ You can manage IAM [policies](/iam/concepts/#policy) in an Organization if you a ## How to access the policy overview 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Policies** tab. A list of the Organization's IAM policies displays. - + 3. Click the name of the policy you want to manage. Alternatively, click next to the policy, and select **Overview**. Either way, you are taken to the policy's **Overview** page. Follow the steps below depending on the management action you wish to take. @@ -30,7 +36,7 @@ You can manage IAM [policies](/iam/concepts/#policy) in an Organization if you a From the policy's [Overview page](#how-to-access-the-policy-overview): - + - Click directly on the policy name at the top of the page (**instance-manager** in the example above) to edit it, and click when finished. - Click directly on the policy description in the **Policy Information** panel (**data-project-group** in the example above) to edit it, and click when finished. diff --git a/pages/iam/how-to/view-logs.mdx b/pages/iam/how-to/view-logs.mdx index 4e86ed0c36..93033953e8 100644 --- a/pages/iam/how-to/view-logs.mdx +++ b/pages/iam/how-to/view-logs.mdx @@ -10,14 +10,18 @@ dates: validation: 2025-01-02 posted: 2023-11-15 --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-iam-users-dashboard.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the **Logs** tab. A list of the latest actions performed on IAM resources in your Organization appears. You can filter them by date, action, category and by the ID of the IAM principal who performed the action. You can sort them by date. diff --git a/pages/iam/how-to/view-permission-sets.mdx b/pages/iam/how-to/view-permission-sets.mdx index 78e5bc0ba4..c684fbd8b3 100644 --- a/pages/iam/how-to/view-permission-sets.mdx +++ b/pages/iam/how-to/view-permission-sets.mdx @@ -10,17 +10,21 @@ dates: validation: 2025-06-09 posted: 2024-12-03 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-users-dashboard.webp' + You can view the permission sets granted to API keys (via policies) through the Scaleway console, [the API](https://www.scaleway.com/en/developers/api/iam/#path-permission-sets-list-permission-sets), and the Scaleway CLI. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The **Users** tab of the [Identity and Access Management dashboard](https://console.scaleway.com/iam/users) displays. - + 2. Click the name of the user whose permissions you want to view. The user information page displays. To view your own permissions as a Member, you can follow the same process and click your name. If you cannot see your own permissions, contact an admin of the Organization, as you may not have the necessary permissions. @@ -30,7 +34,7 @@ You can view the permission sets granted to API keys (via policies) through the A list of your permission sets for the selected Organization displays. You can see the scope of the permissions, in which [IAM policy](/iam/concepts/#policy) they were defined, and to which [principal](/iam/concepts/#principal) they are attached to. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iam/index.mdx b/pages/iam/index.mdx index b8f122c454..66d56d1e63 100644 --- a/pages/iam/index.mdx +++ b/pages/iam/index.mdx @@ -49,12 +49,12 @@ meta: ## API and CLI - - \ No newline at end of file +/> diff --git a/pages/iam/quickstart.mdx b/pages/iam/quickstart.mdx index 1b16d1079f..c7d3c1b3a7 100644 --- a/pages/iam/quickstart.mdx +++ b/pages/iam/quickstart.mdx @@ -9,14 +9,18 @@ dates: validation: 2025-01-02 posted: 2022-06-10 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iam-concepts.webp' + **I**dentity and **A**ccess **M**anagement (IAM) allows you to share access to the management of your Scaleway resources and Organization settings, in a controlled and secure manner. With IAM, you can invite other users to your [Organization](/iam/concepts/#organization), as well as create IAM applications that represent non-human users with their own API keys. You define permissions for users and applications in your Organization via highly customizable [policies](/iam/concepts/#policy). Policies let you specify exactly what rights users and applications (or groups of users and applications) should have within your Organization. - + Read our dedicated page for a [general overview of IAM](/iam/reference-content/overview/) and how it works. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iam/reference-content/auto-generated-iam-resources.mdx b/pages/iam/reference-content/auto-generated-iam-resources.mdx index 29f9d23ab7..cf60138663 100644 --- a/pages/iam/reference-content/auto-generated-iam-resources.mdx +++ b/pages/iam/reference-content/auto-generated-iam-resources.mdx @@ -11,6 +11,8 @@ dates: categories: - iam --- +import image from './assets/scaleway-iam-logs-k8s-example.webp' + Sometimes Scaleway might automatically generate IAM resources, such as applications, groups and policies. @@ -18,7 +20,7 @@ This allows policies to be set up with specific product resources as principals. Any time Scaleway automatically creates or deletes an IAM resource, you will see it on your IAM logs. - + ## Kubernetes Kapsule diff --git a/pages/iam/reference-content/guests-to-members-migration.mdx b/pages/iam/reference-content/guests-to-members-migration.mdx index 311fe665b0..b0872e1fb6 100644 --- a/pages/iam/reference-content/guests-to-members-migration.mdx +++ b/pages/iam/reference-content/guests-to-members-migration.mdx @@ -10,6 +10,8 @@ categories: - iam - console --- +import Requirements from '@macros/iam/requirements.mdx' + This document explains how user management changes with the migration of IAM Guests to Members. @@ -65,7 +67,7 @@ The table below summarizes the key account and access management features that S The migration does not have any impact on your production. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAMManager permissions](/iam/concepts/#permission) diff --git a/pages/iam/reference-content/overview.mdx b/pages/iam/reference-content/overview.mdx index 088142b10d..2d4f4fd74e 100644 --- a/pages/iam/reference-content/overview.mdx +++ b/pages/iam/reference-content/overview.mdx @@ -12,6 +12,12 @@ categories: - iam - console --- +import image from './assets/scaleway-iam-organization.webp' +import image2 from './assets/scaleway-iam-policy.webp' +import image3 from './assets/scaleway-iam-create-app.webp' +import image4 from './assets/scaleway-iam-concepts.webp' +import image5 from './assets/scaleway-iam-api-key.webp' + **I**dentity and **A**ccess **M**anagement (IAM) allows you to share access to the management of your Scaleway resources in a controlled and secure manner. This document aims to give you an overview of how you can use IAM, and explains some of the terminology and processes in a logical and chronological order. @@ -23,7 +29,7 @@ Organizations, Projects and resources are fundamental Scaleway concepts. Knowing When you create your Scaleway account, an [Organization](/iam/concepts/#organization) is automatically created, of which you are the Owner. You have full access and rights to all resources within your own Organization, as well as to Organization management features (support plans, abuse tickets, support tickets etc.), billing and IAM features, as shown in the diagram below. - + You can also be added to an existing Organization as a [Member](#member). Your permissions in these Organizations will depend on the policies set for you by the Organization administrator. @@ -42,7 +48,7 @@ If you want to give someone else permission to view, edit, create or manage reso 1. [Create a new IAM Member](/iam/how-to/manage-members/#how-to-create-a-member). You can provide them the credentials necessary to [log in as a Member](/iam/how-to/log-in-as-a-member) in your Organization. 2. Give the user permissions via [policies](/iam/concepts/#policy). Create a policy to define what permissions and access rights you want the user to have in your Organization. - + Below are two examples of contrasting use cases for permissions: @@ -57,13 +63,13 @@ Check out our full documentation on [policies](/iam/reference-content/policy/) f You may want to give access to your Organization and resources not to a specific human user, but to an application or service, e.g. when setting up a production environment. You can do this by creating [IAM applications](/iam/concepts/#application). This feature lets you give programmatic access to resources by creating API keys that are not linked to a specific human, making your production code more robust. As with users, you can give permissions and access rights to each IAM application via policies. - + ### Defining groups When you create a policy to define permissions for IAM users and applications, the [Groups](/iam/concepts/#group) feature lets you apply one policy to multiple users and/or applications at the same time. For example, you can create a group called “Billing”, add all the users/applications who need access to billing, and then attach a policy to the group which gives rights to manage your Organization's billing. - + ### Generating API keys @@ -71,7 +77,7 @@ You can use the [Scaleway console](https://console.scaleway.com) to create and m With the introduction of IAM, an API key is now associated with an IAM [user](/iam/concepts/#user) or [application](/iam/concepts/#application), and is always scoped per Organization. API keys inherit their permissions from their bearer (the user or application). You can generate one or several API keys for yourself in each of your Organizations via the console. If you are creating an IAM application, you can also generate API keys for that application. You cannot generate API keys for other human IAM users regardless of your IAM permissions, though you may be able to delete others' API keys within your Organization. - + ## Getting started diff --git a/pages/iam/reference-content/policy.mdx b/pages/iam/reference-content/policy.mdx index 2427bd2400..e203e31627 100644 --- a/pages/iam/reference-content/policy.mdx +++ b/pages/iam/reference-content/policy.mdx @@ -12,6 +12,8 @@ categories: - iam - console --- +import image from './assets/scaleway-iam-policy-example.webp' + IAM Policies are statements that define the permissions of users, groups, and applications in Scaleway Organizations. @@ -33,7 +35,7 @@ A principal is an entity that can be attached to a policy. Currently, you can at A rule is the part of a policy that defines the permissions of the policy's [principal](/iam/concepts/#principal), and the [scope](/iam/concepts/#scope) of these permissions. It consists of a **scope** (at Project level or Organization level) and one or more **permission sets** (eg. "list all Instances"). - + A policy can have one or many rules. Note that rules can only **give** access to the specified actions/resources. You cannot create a rule that explicitly **denies** access to specific actions/resources. In any case, the default starting point for any user or application other than the Organization's owner, is that they have zero permissions other than those defined via policies attached to them. diff --git a/pages/iam/reference-content/reproduce-roles-project-api-keys.mdx b/pages/iam/reference-content/reproduce-roles-project-api-keys.mdx index 811d9c5a8f..74da85d196 100644 --- a/pages/iam/reference-content/reproduce-roles-project-api-keys.mdx +++ b/pages/iam/reference-content/reproduce-roles-project-api-keys.mdx @@ -12,6 +12,10 @@ categories: - iam - console --- +import image from './assets/scaleway-iam-roles-change.webp' +import image2 from './assets/scaleway-iam-invitation-groups.webp' +import image3 from './assets/scaleway-iam-api-key-change.webp' + [Identity and Access Management](/iam/concepts/) provides a set of concepts and features to help you easily manage access to your Scaleway Organization. @@ -25,11 +29,11 @@ We strongly recommend that you apply the principle of the least privilege when s When your Organization was migrated to IAM, three [groups](/iam/concepts/#group) were created, with three [policies](/iam/concepts/#policy) attached to them. - + You can keep adding users to these groups if you want to preserve the “old” system of roles and their corresponding rights. Make sure that you therefore do not delete the groups that were created during the migration process. - + If you previously deleted these groups from your Organization, you can recreate them by following these steps: @@ -48,7 +52,7 @@ If you previously deleted these groups from your Organization, you can recreate When your Organization was migrated to IAM, for each Project existing at the time of the migration, an [application](/iam/concepts/#application) and a [policy](/iam/concepts/#policy) were automatically created. These were both given the same name: `Project - [name of the project] (id of the project)`. - + If you want to create Project-scoped API keys for Projects created after your Organization migrated to IAM, follow these steps: 1. [Create an application](/iam/how-to/create-application/), preferably with a name related to the Project. diff --git a/pages/iam/reference-content/users-groups-and-applications.mdx b/pages/iam/reference-content/users-groups-and-applications.mdx index 3acf41743f..be4eff5250 100644 --- a/pages/iam/reference-content/users-groups-and-applications.mdx +++ b/pages/iam/reference-content/users-groups-and-applications.mdx @@ -8,6 +8,8 @@ content: dates: validation: 2025-04-23 --- +import image from './assets/scaleway-iam-concepts.webp' + IAM users, groups, and applications are principals in Scaleway Organizations. A principal is an entity that can be attached to a policy. @@ -40,7 +42,7 @@ If you want to create an API key that is not linked to any particular human user An IAM group is a grouping of users and/or applications. - + You can create groups to attach policies to multiple users and/or applications at the same time. diff --git a/pages/iam/troubleshooting/cannot-use-resources.mdx b/pages/iam/troubleshooting/cannot-use-resources.mdx index 5d11fbd169..6bcbd64a6b 100644 --- a/pages/iam/troubleshooting/cannot-use-resources.mdx +++ b/pages/iam/troubleshooting/cannot-use-resources.mdx @@ -12,8 +12,10 @@ dates: categories: - iam --- +import Requirements from '@macros/iam/requirements.mdx' + - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iam/troubleshooting/index.mdx b/pages/iam/troubleshooting/index.mdx index 8e4190e530..1c46b4721b 100644 --- a/pages/iam/troubleshooting/index.mdx +++ b/pages/iam/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: IamProductIcon ## Featured Pages - - - - - - - - - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/cli-cheatsheet.mdx b/pages/instances/api-cli/cli-cheatsheet.mdx index fc1389c2cd..f15222849c 100644 --- a/pages/instances/api-cli/cli-cheatsheet.mdx +++ b/pages/instances/api-cli/cli-cheatsheet.mdx @@ -11,14 +11,18 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-instances-cli-cheatsheet.webp' + This page shows the most common Scaleway CLI commands for creating and managing Scaleway Instances. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - + diff --git a/pages/instances/api-cli/creating-a-volume.mdx b/pages/instances/api-cli/creating-a-volume.mdx index 1af86a63fa..bc7401e098 100644 --- a/pages/instances/api-cli/creating-a-volume.mdx +++ b/pages/instances/api-cli/creating-a-volume.mdx @@ -13,12 +13,14 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + Creating Block Storage volumes via the Instances API is deprected and the information below is proposed for informative purposes only. [Learn how to create a volume using the Block Storage API.](https://www.scaleway.com/en/developers/api/block/#path-volume-create-a-volume) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/creating-backups.mdx b/pages/instances/api-cli/creating-backups.mdx index 32f704f46d..f1abbd9b67 100644 --- a/pages/instances/api-cli/creating-backups.mdx +++ b/pages/instances/api-cli/creating-backups.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The Backup feature is used to back up your Instance data. It creates an image of a snapshot that contains all your volumes. You can create backups of your Instances using either the [Scaleway CLI tool](/scaleway-cli/quickstart/) or the [Instances API](https://www.scaleway.com/en/developers/api/instance/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/creating-managing-instances-with-cliv2.mdx b/pages/instances/api-cli/creating-managing-instances-with-cliv2.mdx index 021c1ff382..d395ac175b 100644 --- a/pages/instances/api-cli/creating-managing-instances-with-cliv2.mdx +++ b/pages/instances/api-cli/creating-managing-instances-with-cliv2.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Instances provide you with resources to develop, test code and deploy your applications in no time. Instances are designed for modern workflows. They are with you from prototyping to large-scale deployment. You can [create](/instances/how-to/create-an-instance/) and manage your Instances from the [console](https://account.scaleway.com/login), via the [API](https://www.scaleway.com/en/developers/api/instance/) or the [Scaleway Command Line Interface](https://github.com/scaleway/scaleway-cli). @@ -19,7 +21,7 @@ Scaleway Instances provide you with resources to develop, test code and deploy y [The Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and manage Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/detaching-a-volume.mdx b/pages/instances/api-cli/detaching-a-volume.mdx index 1d99748c26..325e197ad7 100644 --- a/pages/instances/api-cli/detaching-a-volume.mdx +++ b/pages/instances/api-cli/detaching-a-volume.mdx @@ -13,8 +13,10 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/increasing-volume-size.mdx b/pages/instances/api-cli/increasing-volume-size.mdx index 8ec42dc072..a64ef96143 100644 --- a/pages/instances/api-cli/increasing-volume-size.mdx +++ b/pages/instances/api-cli/increasing-volume-size.mdx @@ -13,6 +13,8 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + Management of Block Storage volumes via the Instances API is deprecated. We recommend migrating existing volumes to the Block Storage API for continued support and improved functionality. For step-by-step instructions on migrating your volumes, refer to our [How to migrate existing volumes and snapshots to Scaleway's new Block Storage management](/instances/how-to/migrate-volumes-snapshots-to-sbs/). @@ -20,7 +22,7 @@ categories: The Instances API allows you to interact with Block Storage volumes programmatically through API calls. To increase the size of a volume using the Block Storage API, refer to the [dedicated documentation](/block-storage/api-cli/increasing-volume-size/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx b/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx index 78566f1fea..e1d3c34620 100644 --- a/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx +++ b/pages/instances/api-cli/managing-instance-snapshot-via-cli.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + You can use the Scaleway CLI to create, export, and import snapshots of your Instances. A snapshot is a [QCOW2 image](https://en.wikipedia.org/wiki/Qcow) of your Instance's volumes, stored in a Scaleway Object Storage bucket. It can be imported into any Availability Zone, as long as it is in the same region as the bucket in which it is hosted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/migrating-instances.mdx b/pages/instances/api-cli/migrating-instances.mdx index 95fc85209e..3e36c6c15b 100644 --- a/pages/instances/api-cli/migrating-instances.mdx +++ b/pages/instances/api-cli/migrating-instances.mdx @@ -12,11 +12,13 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + It is possible to change the commercial type of an Instance by using the [Scaleway CLI tool](/scaleway-cli/quickstart/) or the [Instances API](https://www.scaleway.com/en/developers/api/instance/). To do so, you need the Instance’s ID and a valid API key. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/snapshot-import-export-feature.mdx b/pages/instances/api-cli/snapshot-import-export-feature.mdx index 788f9ddc26..bcd0239fdd 100644 --- a/pages/instances/api-cli/snapshot-import-export-feature.mdx +++ b/pages/instances/api-cli/snapshot-import-export-feature.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The snapshot transfer feature allows you to export or import Instances snapshots. Snapshots are created using the QCOW2 format and their data is stored in a Scaleway Object Storage Bucket. These images can then be used to create a copy of an Instance in a different AZ. @@ -22,7 +24,7 @@ More information on the QCOW2 file format, and how to use it can be found in the This page shows you how to use the snapshot import/export feature with the Scaleway API. The import/export feature is also available in the console, CLI, and SDK. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/using-cloud-init.mdx b/pages/instances/api-cli/using-cloud-init.mdx index f1f6ed3c14..cab6c87793 100644 --- a/pages/instances/api-cli/using-cloud-init.mdx +++ b/pages/instances/api-cli/using-cloud-init.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Cloud-init is a package that contains utilities for early initialization of cloud Instances. It enables automatic configuration of cloud Instances as it boots into the cloud, turning it from a generic Ubuntu image into a configured server in a few seconds, quickly and easily. @@ -19,7 +21,7 @@ The cloud-init program is available on recent distributions (Ubuntu, Fedora, Deb Cloud-config files are special scripts designed to be run by the cloud-init process. These are generally used for initial configuration on the very first boot of a server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/using-placement-groups.mdx b/pages/instances/api-cli/using-placement-groups.mdx index 2f0d7cad79..90e5bec113 100644 --- a/pages/instances/api-cli/using-placement-groups.mdx +++ b/pages/instances/api-cli/using-placement-groups.mdx @@ -11,6 +11,8 @@ tags: compute placement-group server api instance dates: validation: 2025-02-11 --- +import Requirements from '@macros/iam/requirements.mdx' + Placement groups allow you to group your Instances. @@ -18,7 +20,7 @@ You can choose between two operating modes: `max_availability`, which ensures th If you prefer a visual environment, discover [how to manage placement groups from the Scaleway console](/instances/how-to/use-placement-groups/). - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/api-cli/using-routed-ips.mdx b/pages/instances/api-cli/using-routed-ips.mdx index 2c80ddffb3..2bbecf048f 100644 --- a/pages/instances/api-cli/using-routed-ips.mdx +++ b/pages/instances/api-cli/using-routed-ips.mdx @@ -12,8 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/concepts.mdx b/pages/instances/concepts.mdx index 62564768cc..00a7701e65 100644 --- a/pages/instances/concepts.mdx +++ b/pages/instances/concepts.mdx @@ -11,18 +11,26 @@ dates: categories: - compute --- +import AvailabilityZone from '@macros/concepts/availability-zone.mdx' +import BlockSnapshot from '@macros/concepts/block-snapshot.mdx' +import BlockVolumes from '@macros/concepts/block-volumes.mdx' +import LocalVolumes from '@macros/concepts/local-volumes.mdx' +import Region from '@macros/concepts/region.mdx' +import Volumes from '@macros/concepts/volumes.mdx' +import StorageBootOnBlock from '@macros/storage/boot-on-block.mdx' + ## Availability Zone - + ## Block volumes - + ## Boot-on-block - + ## Carrier-grade NAT (CGNAT) @@ -86,7 +94,7 @@ With IP mobility, there are no NAT IPs anymore. The public IP is entirely routed ## Local volumes - + ## Placement groups @@ -126,7 +134,7 @@ Public IP addresses are routed on the internet. You can enter the public IP addr ## Region - + ## Rescue mode @@ -150,7 +158,7 @@ Security groups allow you to [create rules to drop or allow public traffic comin ## Snapshot - + ## Snapshot type @@ -174,4 +182,4 @@ Tags allow you to organize, sort, filter, and monitor your cloud resources using ## Volumes - \ No newline at end of file + \ No newline at end of file diff --git a/pages/instances/how-to/configure-reverse-dns.mdx b/pages/instances/how-to/configure-reverse-dns.mdx index 93e40076fe..8815d541c0 100644 --- a/pages/instances/how-to/configure-reverse-dns.mdx +++ b/pages/instances/how-to/configure-reverse-dns.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Reverse DNS is the opposite of classic "forward" DNS and maps an IP address to a hostname. This can be useful if, for example, you want to send emails from your server. @@ -19,7 +21,7 @@ Reverse DNS is the opposite of classic "forward" DNS and maps an IP address to a Using the default reverse DNS (*.pub.instances.scw.cloud) may lead to issues with the deliverability of your emails and subscription to tools like [Junk Mail Reporting Program](https://postmaster.live.com/snds/JMRP.aspx) (JMRP) and [Smart Network Data Services](https://sendersupport.olc.protection.outlook.com/snds/FAQ.aspx#WhatIsSNDS), Microsoft services to whitelist your IP’s on their email servers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/connect-to-instance.mdx b/pages/instances/how-to/connect-to-instance.mdx index 889bbe9a23..2c8d3892ba 100644 --- a/pages/instances/how-to/connect-to-instance.mdx +++ b/pages/instances/how-to/connect-to-instance.mdx @@ -12,10 +12,17 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-putty-main.webp' +import image2 from './assets/scaleway-putty-ssh.webp' +import image3 from './assets/scaleway-putty-security.webp' +import image4 from './assets/scaleway-putty-logged.webp' + This page shows how to connect to your Scaleway Instance via SSH. Thanks to the SSH key that you created and uploaded, you can use a terminal application on your local computer to remotely connect to your Instance as root. This enables you to use your Instance as you wish. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -57,7 +64,7 @@ This page shows how to connect to your Scaleway Instance via SSH. Thanks to the 1. [Download and install PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html). 2. Launch PuTTY on your computer. The main screen of the application displays: - + 3. Enter your Instance's IP address in the **Hostname** field. To find the IP address of your Instance, log into the Scaleway console and @@ -65,15 +72,15 @@ This page shows how to connect to your Scaleway Instance via SSH. Thanks to the Instances and their associated IP addresses will display. 4. In the side menu, expand the **Connection**, **SSH** and **Auth** submenus, then click **Credentials**: - + 5. Click the **Browse** button and select the private key file you [generated previously](/organizations-and-projects/how-to/create-ssh-key/). 6. Click **Open** at the bottom of the screen to open a connection to the Instance. Upon the first connection, PuTTY asks you to allow the connection to the host. 7. Click **OK** to confirm. - + The terminal window displays. 8. Enter the username `root` and press **Enter** to authenticate against the server with your SSH key. - + You are now connected to your Instance. diff --git a/pages/instances/how-to/create-a-backup.mdx b/pages/instances/how-to/create-a-backup.mdx index 166b606a69..a0c614b8aa 100644 --- a/pages/instances/how-to/create-a-backup.mdx +++ b/pages/instances/how-to/create-a-backup.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The image feature lets you create an image of your Instance, which contains all its volumes. You can use this image to restore your Instance and its data and create a series of Instances with a predefined configuration. @@ -21,7 +23,7 @@ This feature is available on Instance types. Creating images of your Instance is This creates an image that is a complete backup of your Instance including **all** of its volumes. The [snapshot](/instances/concepts/#snapshot) feature, on the other hand, creates snapshots of specific volumes. Consider [creating a snapshot](/block-storage/how-to/create-a-snapshot/) if you want to use different snapshot strategies for different volumes of your Instance, e.g., if it has one volume containing the OS and another containing application data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/create-an-instance.mdx b/pages/instances/how-to/create-an-instance.mdx index 14e12ea743..fec401f81f 100644 --- a/pages/instances/how-to/create-an-instance.mdx +++ b/pages/instances/how-to/create-an-instance.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to create your first Scaleway Instance. An [Instance](/instances/concepts/#instance) is a virtual machine in the cloud. Just like a physical machine, it has resources - virtualized CPU, RAM, storage etc. - which vary depending on the [Instance type](/instances/reference-content/choosing-instance-type/) you choose. After you have created your Instance you can [connect](/instances/how-to/connect-to-instance/) to it and use it for a wide range of computing use cases depending on the Instance type you chose, from running small-scale tests and personal projects to hosting applications and development environments to setting up a production environment. @@ -21,7 +23,7 @@ Select a tab below for instructions on how to create an Instance via either our - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -60,7 +62,7 @@ Select a tab below for instructions on how to create an Instance via either our - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -107,7 +109,7 @@ Select a tab below for instructions on how to create an Instance via either our - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -208,7 +210,7 @@ Select a tab below for instructions on how to create an Instance via either our - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/create-image-from-snapshot.mdx b/pages/instances/how-to/create-image-from-snapshot.mdx index 73d36ed0a2..6f0908a130 100644 --- a/pages/instances/how-to/create-image-from-snapshot.mdx +++ b/pages/instances/how-to/create-image-from-snapshot.mdx @@ -12,8 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/delete-instance.mdx b/pages/instances/how-to/delete-instance.mdx index d13491a5b2..a9f1e3728d 100644 --- a/pages/instances/how-to/delete-instance.mdx +++ b/pages/instances/how-to/delete-instance.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete an Instance. @@ -19,7 +21,7 @@ This page shows you how to delete an Instance. Deleting an Instance is an **irreversible action**. Any data stored on your Instance will be lost. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/manage-storage.mdx b/pages/instances/how-to/manage-storage.mdx index 1af6b25bac..97fdcdc423 100644 --- a/pages/instances/how-to/manage-storage.mdx +++ b/pages/instances/how-to/manage-storage.mdx @@ -12,8 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/migrate-instances.mdx b/pages/instances/how-to/migrate-instances.mdx index 163ddf4063..71d8ae223b 100644 --- a/pages/instances/how-to/migrate-instances.mdx +++ b/pages/instances/how-to/migrate-instances.mdx @@ -12,12 +12,14 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The Scaleway platform makes it very easy to migrate your data from one Instance to another or upgrade your Instance to a more powerful one if your requirements grow. In this how-to, we will upgrade an Instance by migrating from a [DEV1-S](/instances/concepts/#development-instance) Instance to a [GP1-XS](/instances/reference-content/cost-optimized/#development-instances-and-general-purpose-instances) Instance. The new GP1-XS Instance will have the same [flexible IP](/instances/concepts/#flexible-ip) as the original DEV1-S Instance. For more information about choosing the best Instance type to migrate to for your use case, see our [dedicated documentation](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/migrate-local-storage-to-sbs.mdx b/pages/instances/how-to/migrate-local-storage-to-sbs.mdx index faf2fc5912..a5219e011c 100644 --- a/pages/instances/how-to/migrate-local-storage-to-sbs.mdx +++ b/pages/instances/how-to/migrate-local-storage-to-sbs.mdx @@ -11,11 +11,13 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial guides you through the process of migrating your Instance's Local Storage (`l_ssd`) to Scaleway Block Storage (SBS). By following these steps, you will be able to export your local storage and restart your Instance with SBS. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Instance](/instances/how-to/create-an-instance/) using [Local Storage (`l_ssd`)](/local-storage/) diff --git a/pages/instances/how-to/migrate-routed-ips.mdx b/pages/instances/how-to/migrate-routed-ips.mdx index c183120496..c9d23bd899 100644 --- a/pages/instances/how-to/migrate-routed-ips.mdx +++ b/pages/instances/how-to/migrate-routed-ips.mdx @@ -12,6 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-instance-routedip-transition.webp' + The migration to routed IPs is now complete. The following information is provided for reference only. @@ -31,7 +35,7 @@ In addition to the benefits explained above, routed IPs allow precise control ov * Before proceeding with the migration, please review the [FAQ on IP autoconfiguration limitations](/instances/faq/#are-there-any-limitations-on-ip-autoconfiguration-with-the-routed-ip-feature) and the [guide to fix unreachable Ubuntu Focal Instances with multiple public IPs](/instances/troubleshooting/fix-unreachable-focal-with-two-public-ips/). These resources provide important information to ensure a seamless migration process. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [Instance](/instances/how-to/create-an-instance/) that has not been moved to routed IPs @@ -68,7 +72,7 @@ If `scaleway-ecosystem` is not installed, no additional steps are needed for thi ## Moving the Instance to routed IPs 1. Select **CPU Instances** from the **Compute** category in the sidebar menu. This will show a list of your Instances. Those eligible to transition to routed IPs are identified with an exclamation mark icon. - + 2. Click **Move IP** next to the Instance you wish to move to routed flexible IPs. A pop-up displays. Alternatively, you can initiate the transition from your Instance's overview page by clicking the **Move IP** button. diff --git a/pages/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx b/pages/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx index d7b0de244a..499a0049a4 100644 --- a/pages/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx +++ b/pages/instances/how-to/migrate-volumes-snapshots-to-sbs.mdx @@ -12,5 +12,7 @@ dates: categories: - compute --- +import HowToMigrateToSbs from '@macros/compute/how-to-migrate-to-sbs.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/instances/how-to/power-off-instance.mdx b/pages/instances/how-to/power-off-instance.mdx index ee62449f15..abf78771ff 100644 --- a/pages/instances/how-to/power-off-instance.mdx +++ b/pages/instances/how-to/power-off-instance.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Powering off your Instance shuts it down by transferring all the data on the Instance's local volume to a volume store. The physical node is released back to the pool of available machines. If the Instance has a flexible IP, it will remain available in your account. @@ -20,7 +22,7 @@ Powering off your Instance shuts it down by transferring all the data on the Ins - Powering off may take some time, depending on the amount of data in the Instance’s local volume. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/resize-instances.mdx b/pages/instances/how-to/resize-instances.mdx index 460d4741d7..c3a62b7952 100644 --- a/pages/instances/how-to/resize-instances.mdx +++ b/pages/instances/how-to/resize-instances.mdx @@ -12,6 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-instance-change-offer.webp' + You can adjust the size of your Scaleway Instances (also known as vertical scaling) to meet changing workload demands and optimize resource usage. Whether you need to scale up to handle increased traffic, scale down to reduce costs, or simply reconfigure your Instance to better align with your application’s requirements, vertical scaling lets you increase or decrease computational power without the hassle of destroying and recreating Instances. @@ -19,7 +23,7 @@ Scaleway’s flexible infrastructure allows you to modify CPU and RAM allocation Alternatively, you can also resize your Instance using the command line by following the guide [Changing the commercial type of an Instance with the API or CLI](/instances/api-cli/migrating-instances/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -28,7 +32,7 @@ Alternatively, you can also resize your Instance using the command line by follo 1. Click **CPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays. 2. Click the Instance you want to resize. The **Overview** page for that Instance displays. 3. Click **Change offer** in the **Instance information** section of the overview page. The change offer page displays. - + 4. Select a new Instance configuration from the list of available offers. Recommended configurations will be highlighted. 5. Review pricing and compare the monthly cost of the new configuration with your current offer. 6. Click **Change offer type** to proceed. diff --git a/pages/instances/how-to/send-emails-from-your-instance.mdx b/pages/instances/how-to/send-emails-from-your-instance.mdx index 9ee1bac325..48c09afd00 100644 --- a/pages/instances/how-to/send-emails-from-your-instance.mdx +++ b/pages/instances/how-to/send-emails-from-your-instance.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + By default, remote SMTP ports (25, 465, and 587) are blocked and cannot be accessed from our infrastructure to prevent spam. To send emails from your Instance, you need to open these ports in the security group configuration. @@ -19,7 +21,7 @@ By default, remote SMTP ports (25, 465, and 587) are blocked and cannot be acces This document concerns enabling SMTP for Instances. If you want to enable SMTP on other resources, see our documentation on [enabling SMTP on Elastic Metal servers](/elastic-metal/how-to/enable-smtp/) and [enabling SMTP on Public Gateways](/public-gateways/how-to/configure-a-public-gateway/#how-to-enable-smtp). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/snapshot-import-export-feature.mdx b/pages/instances/how-to/snapshot-import-export-feature.mdx index 345f58d2ff..e3f06bcafd 100644 --- a/pages/instances/how-to/snapshot-import-export-feature.mdx +++ b/pages/instances/how-to/snapshot-import-export-feature.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The snapshot transfer feature allows you to export or import Instance snapshots. Snapshots are created using the QCOW2 format and stored in a Scaleway Object Storage Bucket. @@ -19,7 +21,7 @@ A snapshot stored in a Scaleway Object Storage bucket can be imported into any A More information on the QCOW2 file format and how to use it can be found in the [QEMU documentation](https://www.qemu.org/docs/master/system/images.html#cmdoption-image-formats-arg-qcow2). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-boot-modes.mdx b/pages/instances/how-to/use-boot-modes.mdx index 28be4082e3..5afc45d19e 100644 --- a/pages/instances/how-to/use-boot-modes.mdx +++ b/pages/instances/how-to/use-boot-modes.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + You can boot your Instances using local boot or a rescue image. This page explains how to use each of these boot modes. @@ -21,7 +23,7 @@ You can boot your Instances using local boot or a rescue image. This page explai - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-flexips.mdx b/pages/instances/how-to/use-flexips.mdx index 4c7302d115..fecad59017 100644 --- a/pages/instances/how-to/use-flexips.mdx +++ b/pages/instances/how-to/use-flexips.mdx @@ -12,6 +12,9 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' +import FlexibleIp from '@macros/network/flexible-ip-limitations.mdx' + This page provides guidance on using [flexible IP addresses](/instances/concepts/#flexible-ip) with your Scaleway Instances. @@ -28,13 +31,13 @@ You can assign up to five (5) flexible routed IP addresses to each Instance. Instances using routed public IPv4 addresses can also use flexible IPv6 addresses. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Instance](/instances/how-to/create-an-instance/) - + ## How to detach a flexible IP address from an Instance diff --git a/pages/instances/how-to/use-placement-groups.mdx b/pages/instances/how-to/use-placement-groups.mdx index 2849c81379..301cfbe9bd 100644 --- a/pages/instances/how-to/use-placement-groups.mdx +++ b/pages/instances/how-to/use-placement-groups.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + [Placement groups](/instances/concepts/#placement-groups) allow you to define if you want certain Instances to run on different physical hypervisors for maximum availability or as physically close together as possible for minimum latency. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-private-networks.mdx b/pages/instances/how-to/use-private-networks.mdx index 2b766836f6..95c9d945b2 100644 --- a/pages/instances/how-to/use-private-networks.mdx +++ b/pages/instances/how-to/use-private-networks.mdx @@ -12,12 +12,14 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/vpc/concepts/#private-networks) allow your Instances to communicate in an isolated and secure network without needing to be connected to the public internet. Each Instance can be connected to one or several Private Networks, letting you build your own network topologies. Private Networks are LAN-like layer 2 ethernet networks. A new network interface with a unique media access control address (MAC address) is configured on each Instance in a Private Network. Private Networks' built-in DHCP server manages the distribution of private IP addresses for Instances (and other resources) when they are attached to the network. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-protected-instance.mdx b/pages/instances/how-to/use-protected-instance.mdx index 08b2db394e..4bd9e5af07 100644 --- a/pages/instances/how-to/use-protected-instance.mdx +++ b/pages/instances/how-to/use-protected-instance.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + The [Protected Instance](/instances/concepts/#protected-instance) feature is used to prevent any `halt` action from being performed on your Instance. This only applies to running Instances. Enabling the Protected Instance feature means that you will not be able to delete, power off, or reboot your Instance, nor put it into standby mode. This feature is useful to avoid hazardous manipulations, such as batch deletion of Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-security-groups.mdx b/pages/instances/how-to/use-security-groups.mdx index f0207e6f0a..cec831bb92 100644 --- a/pages/instances/how-to/use-security-groups.mdx +++ b/pages/instances/how-to/use-security-groups.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + [Security groups](/instances/concepts/#security-group) act as firewalls, filtering public internet traffic on your Instances. They can be stateful or stateless, and allow you to create rules to drop or allow traffic to and from your Instance. On this page, we show you how to create, edit, and configure a security group via the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/how-to/use-serial-console.mdx b/pages/instances/how-to/use-serial-console.mdx index ab44128f03..c6407c992d 100644 --- a/pages/instances/how-to/use-serial-console.mdx +++ b/pages/instances/how-to/use-serial-console.mdx @@ -12,10 +12,14 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-connect-tty.webp' + This page shows how to connect to your Scaleway Instance from the Scaleway console using the serial console (TTY, from **T**ele**TY**pewriter). It provides a way to connect to your Instance for debugging, or if it loses its network connectivity. The serial console remains available even if you can not reach your Instance over the internet. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -32,7 +36,7 @@ This page shows how to connect to your Scaleway Instance from the Scaleway conso 1. Click **CPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays. 2. Click the Instance you want to connect to. 3. Click **Console** on the Instance **Overview** page. The serial console (TTY) displays in a pop-up. - + 4. Login using your Linux user and password. You can now run all Linux commands like in an SSH shell. diff --git a/pages/instances/how-to/use-standby-mode.mdx b/pages/instances/how-to/use-standby-mode.mdx index d91b76aaf0..0aa2b6c83a 100644 --- a/pages/instances/how-to/use-standby-mode.mdx +++ b/pages/instances/how-to/use-standby-mode.mdx @@ -12,10 +12,14 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-standby-mode.webp' + [Standby mode](/instances/concepts/#standby-mode) temporarily stops an Instance. The Instance remains allocated to your account and all data remains on the Local Storage of the Instance. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -26,7 +30,7 @@ categories: 1. Click **CPU Instances** in the **Compute** section of the side menu. The [Instances page](https://console.scaleway.com/instance/servers) displays. 2. Click the Instance you want to put into standby mode. The Overview page for that Instance displays. 3. Scroll down to the **Standby mode** section - + 4. Click **Switch to standby mode**. A pop-up displays asking you to confirm the action. 5. Click **Switch Instance to standby mode** to confirm. diff --git a/pages/instances/index.mdx b/pages/instances/index.mdx index ff0616c632..f1172db5f7 100644 --- a/pages/instances/index.mdx +++ b/pages/instances/index.mdx @@ -49,22 +49,22 @@ meta: ## Tutorials - - - - \ No newline at end of file +/> diff --git a/pages/instances/quickstart.mdx b/pages/instances/quickstart.mdx index fdf3fe234e..9f9045b0c4 100644 --- a/pages/instances/quickstart.mdx +++ b/pages/instances/quickstart.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway [Instances](/instances/concepts/#instance) are computing units that provide you with resources to run your applications. After you have created your Instance and installed your image of choice (e.g., an operating system), you can connect to it via SSH to use it as you wish. When you are done using the Instance, you can delete it from your account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/reference-content/add-instance-specific-ssh-keys-using-tags.mdx b/pages/instances/reference-content/add-instance-specific-ssh-keys-using-tags.mdx index 1ac4500af6..8e5f5f7d18 100644 --- a/pages/instances/reference-content/add-instance-specific-ssh-keys-using-tags.mdx +++ b/pages/instances/reference-content/add-instance-specific-ssh-keys-using-tags.mdx @@ -12,13 +12,15 @@ dates: posted: 2024-10-08 tags: instance ssh-key ssh tag --- +import Requirements from '@macros/iam/requirements.mdx' + In cloud environments, managing SSH keys across multiple Instances is key to keeping your infrastructure secure and easy to access. Sometimes, you need to ensure that a specific SSH key grants access to only one Instance and does not automatically apply to others. This can simplify key management and improve security, especially when you are running many Instances - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/reference-content/images-and-instantapps.mdx b/pages/instances/reference-content/images-and-instantapps.mdx index c675cf4959..c62177e7f1 100644 --- a/pages/instances/reference-content/images-and-instantapps.mdx +++ b/pages/instances/reference-content/images-and-instantapps.mdx @@ -12,6 +12,19 @@ dates: categories: - compute --- +import image from './assets/ubuntu.webp' +import image2 from './assets/ubuntu.webp' +import image3 from './assets/debian.webp' +import image4 from './assets/centos.webp' +import image5 from './assets/fedora.webp' +import image6 from './assets/rockylinux.webp' +import image7 from './assets/almalinux.webp' +import image8 from './assets/nextcloud.webp' +import image9 from './assets/gitlab.webp' +import image10 from './assets/openvpn.webp' +import image11 from './assets/wordpress.webp' +import image12 from './assets/docker.webp' + ## OS images @@ -20,13 +33,13 @@ Scaleway manages the deployment and maintenance of these OS images, ensuring the | Distribution | Description | |---|---| -| | **Ubuntu 24.04** the latest long-term support (LTS) version of the world's most popular Linux operating system, offers reliability and stability with five years of guaranteed free updates.
[Deploy Ubuntu](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=607b12c2-685d-45f7-905f-57bc23863834&offerName=PRO2-S&zone=fr-par-1) | -| | **Ubuntu ML**, Scaleway’s [optimized version](/gpu/reference-content/docker-images/) of Ubuntu is tailored for machine learning, featuring essential frameworks, tools, and packages. This includes the NVIDIA Container Toolkit (Docker), PyTorch, TensorFlow 2, NVIDIA RAPIDS, and JAX, ensuring a comprehensive and efficient ML environment.
[Deploy Ubuntu ML](https://console.scaleway.com/instance/servers/create/?area=fr-par-2&imageKey=a6c68db3-5613-4b08-acaa-2c92d8baf26c&offerName=L40S-1-48G&zone=fr-par-2) | -| | **Debian**, the world-renowned free open-source operating system, featuring over 59,000 packages. Celebrated for its reliability, it is available in its stable branch, Debian 12 (Bookworm).
[Deploy Debian](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=fd6931c1-5326-4f8d-8fdf-57867b2830e3&offerName=PRO2-S&zone=fr-par-1) | -| | **CentOS**, developed using Red Hat® Enterprise Linux®, is characterized by increased stability. It works on computers with both 64-bit and 32-bit architectures and is available as a free distribution. You can choose the version you need directly from the console.
[Deploy CentOS](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=cfb3fa01-6406-4be8-9e9d-29daee2582fa&offerName=PRO2-S) | -| | **Fedora** is a modern Linux distribution with a focus on free software. It features a constantly evolving system supported by a large community and adheres to a regular release schedule. You can select the version you need directly from the console.
[Deploy Fedora](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=186859f6-0152-45dd-9eb8-21fc5e8d774e&offerName=PRO2-S) | -| | **Rocky Linux** is an open-source enterprise operating system designed to be 100% compatible with Red Hat Enterprise Linux®. It is intensively developed and maintained by a dedicated community.
[Deploy Rocky Linux](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=1576bf6b-f640-47f2-9117-968419d0546e&offerName=PRO2-S) | -| | **Alma Linux** is fully binary compatible with Red Hat Enterprise Linux® (RHEL), making it a seamless replacement for CentOS 8.
[Deploy Alma Linux](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=0d3a22da-c634-45d6-a7dd-aff402f88b0c&offerName=PRO2-S) | +| | **Ubuntu 24.04** the latest long-term support (LTS) version of the world's most popular Linux operating system, offers reliability and stability with five years of guaranteed free updates.
[Deploy Ubuntu](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=607b12c2-685d-45f7-905f-57bc23863834&offerName=PRO2-S&zone=fr-par-1) | +| | **Ubuntu ML**, Scaleway’s [optimized version](/gpu/reference-content/docker-images/) of Ubuntu is tailored for machine learning, featuring essential frameworks, tools, and packages. This includes the NVIDIA Container Toolkit (Docker), PyTorch, TensorFlow 2, NVIDIA RAPIDS, and JAX, ensuring a comprehensive and efficient ML environment.
[Deploy Ubuntu ML](https://console.scaleway.com/instance/servers/create/?area=fr-par-2&imageKey=a6c68db3-5613-4b08-acaa-2c92d8baf26c&offerName=L40S-1-48G&zone=fr-par-2) | +| | **Debian**, the world-renowned free open-source operating system, featuring over 59,000 packages. Celebrated for its reliability, it is available in its stable branch, Debian 12 (Bookworm).
[Deploy Debian](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=fd6931c1-5326-4f8d-8fdf-57867b2830e3&offerName=PRO2-S&zone=fr-par-1) | +| | **CentOS**, developed using Red Hat® Enterprise Linux®, is characterized by increased stability. It works on computers with both 64-bit and 32-bit architectures and is available as a free distribution. You can choose the version you need directly from the console.
[Deploy CentOS](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=cfb3fa01-6406-4be8-9e9d-29daee2582fa&offerName=PRO2-S) | +| | **Fedora** is a modern Linux distribution with a focus on free software. It features a constantly evolving system supported by a large community and adheres to a regular release schedule. You can select the version you need directly from the console.
[Deploy Fedora](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=186859f6-0152-45dd-9eb8-21fc5e8d774e&offerName=PRO2-S) | +| | **Rocky Linux** is an open-source enterprise operating system designed to be 100% compatible with Red Hat Enterprise Linux®. It is intensively developed and maintained by a dedicated community.
[Deploy Rocky Linux](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=1576bf6b-f640-47f2-9117-968419d0546e&offerName=PRO2-S) | +| | **Alma Linux** is fully binary compatible with Red Hat Enterprise Linux® (RHEL), making it a seamless replacement for CentOS 8.
[Deploy Alma Linux](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=0d3a22da-c634-45d6-a7dd-aff402f88b0c&offerName=PRO2-S) | ## InstantApps @@ -35,8 +48,8 @@ InstantApps simplify the process of deploying and managing applications in the c | InstantApp | Description | |---|---| -| | **Nextcloud** is the self-hosted productivity platform that keeps you in control. It allows you to store your files, folders, contacts, photo galleries, calendars, and more, and access them from your mobile device, desktop, or web browser.
[Learn more](/tutorials/nextcloud-instantapp/) - [Deploy Nextcloud](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=7d4a7cb1-1fd5-4a64-920b-c79f47367254&offerName=PRO2-S&zone=fr-par-1) | -| | **GitLab** is the most complete DevOps platform, offering a comprehensive CI/CD toolchain within a single application. It serves as a Git repository manager with integrated wiki, issue-tracking, and continuous integration/deployment pipeline features.
[Learn more](/tutorials/gitlab-instant-app/) - [Deploy GitLab](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=233074b9-e2ba-4e78-818e-dd4930ce6bee&offerName=PRO2-S) | -| | **OpenVPN** is the fastest and simplest way to protect your online privacy and surf anonymously. It is easy to deploy and ready to use after your first SSH connection, ensuring quick setup for enhanced security.
[Learn more](/tutorials/openvpn-instant-app/) - [Deploy OpenVPN](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=b6f4edc8-21e6-4aa2-8f52-1030cf6d4dd8&offerName=PRO2-S) | -| | **WordPress**, the most famous blog tool, publishing platform, and content management system (CMS), is an open-source software that enables you to create stunning websites, blogs, or applications effortlessly.
[Learn more](/tutorials/wordpress-instantapp/) - [Deploy WordPress](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=215a50f9-0ba8-4e9c-a4e7-10caf50e3586&offerName=PRO2-S) | -| | **Docker**, the famous container manager encapsulated in a Scaleway image, allows you to deploy your applications within seconds, eliminating concerns about compatibility and dependencies.
[Learn more](/tutorials/docker-instantapp/) - [Deploy Docker](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=c1b530d8-0ca0-45c4-80db-ba06608287b2&offerName=PRO2-S) | +| | **Nextcloud** is the self-hosted productivity platform that keeps you in control. It allows you to store your files, folders, contacts, photo galleries, calendars, and more, and access them from your mobile device, desktop, or web browser.
[Learn more](/tutorials/nextcloud-instantapp/) - [Deploy Nextcloud](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=7d4a7cb1-1fd5-4a64-920b-c79f47367254&offerName=PRO2-S&zone=fr-par-1) | +| | **GitLab** is the most complete DevOps platform, offering a comprehensive CI/CD toolchain within a single application. It serves as a Git repository manager with integrated wiki, issue-tracking, and continuous integration/deployment pipeline features.
[Learn more](/tutorials/gitlab-instant-app/) - [Deploy GitLab](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=233074b9-e2ba-4e78-818e-dd4930ce6bee&offerName=PRO2-S) | +| | **OpenVPN** is the fastest and simplest way to protect your online privacy and surf anonymously. It is easy to deploy and ready to use after your first SSH connection, ensuring quick setup for enhanced security.
[Learn more](/tutorials/openvpn-instant-app/) - [Deploy OpenVPN](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=b6f4edc8-21e6-4aa2-8f52-1030cf6d4dd8&offerName=PRO2-S) | +| | **WordPress**, the most famous blog tool, publishing platform, and content management system (CMS), is an open-source software that enables you to create stunning websites, blogs, or applications effortlessly.
[Learn more](/tutorials/wordpress-instantapp/) - [Deploy WordPress](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=215a50f9-0ba8-4e9c-a4e7-10caf50e3586&offerName=PRO2-S) | +| | **Docker**, the famous container manager encapsulated in a Scaleway image, allows you to deploy your applications within seconds, eliminating concerns about compatibility and dependencies.
[Learn more](/tutorials/docker-instantapp/) - [Deploy Docker](https://console.scaleway.com/instance/servers/create/?area=fr-par-1&imageKey=c1b530d8-0ca0-45c4-80db-ba06608287b2&offerName=PRO2-S) | diff --git a/pages/instances/reference-content/understanding-instance-pricing.mdx b/pages/instances/reference-content/understanding-instance-pricing.mdx index e463d48f5f..d06016bbc8 100644 --- a/pages/instances/reference-content/understanding-instance-pricing.mdx +++ b/pages/instances/reference-content/understanding-instance-pricing.mdx @@ -11,6 +11,9 @@ dates: categories: - compute --- +import image from './assets/scw-estimated-cost.webp' +import image2 from './assets/scaleway-current-consumption.webp' + Scaleway Instances are virtual machines hosted in the cloud. You can create an Instance, pay for it by the hour, and then delete it and stop paying when you no longer need it. @@ -102,13 +105,13 @@ When you [create an Instance](https://console.scaleway.com/instance/servers/crea The estimated cost calculator provides an approximate sum and does not represent a commitment to spend that amount. - + ### Current consumption The **Current consumption** panel in the Scaleway console dashboard estimates your charges for the current month, categorized by Instances, flexible IPs, and storage volumes under **Compute**. - + ### Billing alerts diff --git a/pages/instances/troubleshooting/bootscript-eol.mdx b/pages/instances/troubleshooting/bootscript-eol.mdx index 4da8f549ff..3a8693d8c2 100644 --- a/pages/instances/troubleshooting/bootscript-eol.mdx +++ b/pages/instances/troubleshooting/bootscript-eol.mdx @@ -12,6 +12,8 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Some legacy Instance types (e.g. **VC1-x**, **X64-x**, **Start1-x**) supported the option to use a bootscript (a preconfigured boot configuration) to start your Instance. This boot method was also available on **DEV1-x**, **GP1-x**, and **STARDUST1** Instances. This feature is now deprecated and will no longer be supported. @@ -28,7 +30,7 @@ You can find information about the Instances quotas allocated to your account at To ensure the continued stability of your service, it is crucial to follow the procedures outlined below, as the bootscript feature enters the decommissioning phase. Failure to do so may result in service instability for your Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/troubleshooting/cant-connect-ssh.mdx b/pages/instances/troubleshooting/cant-connect-ssh.mdx index c681865ae4..5894ab7b34 100644 --- a/pages/instances/troubleshooting/cant-connect-ssh.mdx +++ b/pages/instances/troubleshooting/cant-connect-ssh.mdx @@ -12,8 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/troubleshooting/cant-connect-to-instance-with-pn-gateway.mdx b/pages/instances/troubleshooting/cant-connect-to-instance-with-pn-gateway.mdx index 820b54bfe4..3d74093bf6 100644 --- a/pages/instances/troubleshooting/cant-connect-to-instance-with-pn-gateway.mdx +++ b/pages/instances/troubleshooting/cant-connect-to-instance-with-pn-gateway.mdx @@ -12,8 +12,10 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Instance](/instances/how-to/create-an-instance/) diff --git a/pages/instances/troubleshooting/change-rescue-mode.mdx b/pages/instances/troubleshooting/change-rescue-mode.mdx index 13df37d2b6..622e39ac8c 100644 --- a/pages/instances/troubleshooting/change-rescue-mode.mdx +++ b/pages/instances/troubleshooting/change-rescue-mode.mdx @@ -12,11 +12,13 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + Rescue mode is a feature that allows you to boot your Instance on a temporary OS over the network, giving you access to your Instance's file system to troubleshoot and repair issues. This is particularly useful when your Instance is not booting properly due to configuration errors, corrupted files, or other system issues, and you need to recover data or make repairs without affecting the original system. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/instances/troubleshooting/fix-dns-routed-ipv6-only-debian-bullseye.mdx b/pages/instances/troubleshooting/fix-dns-routed-ipv6-only-debian-bullseye.mdx index b5c56ea47b..8b2d9735a3 100644 --- a/pages/instances/troubleshooting/fix-dns-routed-ipv6-only-debian-bullseye.mdx +++ b/pages/instances/troubleshooting/fix-dns-routed-ipv6-only-debian-bullseye.mdx @@ -12,10 +12,12 @@ dates: categories: - compute --- +import Requirements from '@macros/iam/requirements.mdx' + This guide outlines the steps to enable DNS resolution on a Scaleway Instance that uses the Debian Bullseye image, configured with one or more routed IPv6 addresses and without any IPv4 addresses. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [Instance](/instances/how-to/create-an-instance/) running Debian Bullseye (11) with an IPv6-only setup diff --git a/pages/instances/troubleshooting/index.mdx b/pages/instances/troubleshooting/index.mdx index ca35f668b2..19251708ce 100644 --- a/pages/instances/troubleshooting/index.mdx +++ b/pages/instances/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: InstanceProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [Instance](/instances/how-to/create-an-instance/) diff --git a/pages/interlink/concepts.mdx b/pages/interlink/concepts.mdx index 48db97a5e3..9b2bf903f4 100644 --- a/pages/interlink/concepts.mdx +++ b/pages/interlink/concepts.mdx @@ -12,6 +12,8 @@ dates: categories: - networks --- +import image from './assets/scaleway-interlink-diag-simple.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -44,7 +46,7 @@ InterLink, currently in Public Beta, is Scaleway's product to let you create a s Currently, InterLink is available in **hosted** version only. This means that you must choose a compatible [partner](#partner) to facilitate the physical connection between the external infrastructure and the Scaleway VPC. The physical connection may be shared between several clients, each allocated a specific amount of bandwidth for their InterLink. - + For more information on how InterLink works, see our [detailed overview](/interlink/reference-content/overview/). diff --git a/pages/interlink/how-to/complete-provisioning.mdx b/pages/interlink/how-to/complete-provisioning.mdx index 56f11f42b4..2463962216 100644 --- a/pages/interlink/how-to/complete-provisioning.mdx +++ b/pages/interlink/how-to/complete-provisioning.mdx @@ -12,6 +12,12 @@ tags: interlink direct-connect provision hosted partner contact error categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-interlink-ordering.webp' +import image2 from './assets/scaleway-interlink-overview-requesting.webp' +import image3 from './assets/scaleway-interlink-listing.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -19,9 +25,9 @@ InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). After you have [ordered your InterLink](/interlink/how-to/order-interlink), further action is required on both the customer side and the [partner](/interlink/concepts/#partner) side before the InterLink is provisioned and ready for active use. This page walks you through the steps to take and how to deal with potential problems that could arise. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -35,7 +41,7 @@ After ordering the InterLink from Scaleway, you **must** contact your chosen par 2. Click on the InterLink that you want to finish provisioning. The InterLink's **Overview** page displays. - + 3. Note down the [pairing key](/interlink/concepts/#pairing-key) for your InterLink. This is a unique identification number which the partner will need in order to provision your InterLink. @@ -51,7 +57,7 @@ Your InterLink will remain in `Requested` status until the partner responds to y Once you have requested the InterLink from your partner, you must wait for them to respond to your request. There is no further action for you to take at this point. You can keep track of your InterLink's [status](/interlink/reference-content/statuses/) via the [InterLink listing](https://console.scaleway.com/interlink/links) in the Scaleway console. - + When the partner approves your request, the InterLink moves to `Provisioning` status. This means that the partner has agreed to facilitate your InterLink, and is now preparing the resources and configuration necessary to do so. diff --git a/pages/interlink/how-to/configure-interlink.mdx b/pages/interlink/how-to/configure-interlink.mdx index 52b91dbc35..e9bab708d5 100644 --- a/pages/interlink/how-to/configure-interlink.mdx +++ b/pages/interlink/how-to/configure-interlink.mdx @@ -12,6 +12,16 @@ tags: interlink direct-connect configure attach-vpc route-propagation allowed-ro categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-interlink-config.webp' +import image2 from './assets/scaleway-interlink-overview-up.webp' +import image3 from './assets/scaleway-interlink-attach-vpc.webp' +import image4 from './assets/scaleway-interlink-overview-up.webp' +import image5 from './assets/scaleway-attach-routing-policy.webp' +import image6 from './assets/scaleway-interlink-overview-up.webp' +import image7 from './assets/scaleway-interlink-attach-vpc.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -23,11 +33,11 @@ Once your InterLink has been [provisioned](/interlink/how-to/complete-provisioni - Create and attach a routing policy - Activate route propagation - + This document explains how to complete these configuration steps with the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -41,11 +51,11 @@ Attaching an InterLink to a VPC allows you to complete the connection from your 2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays. - + 3. In the **Attached VPC** section, click **Attach VPC**. A pop-up displays: - + 4. Select one of your existing VPCs from the dropdown list. It must be in the same region as the InterLink. Alternatively, click **+ Create VPC** to create and attach a new VPC. @@ -72,11 +82,11 @@ See the dedicated documentation on [creating a routing policy](/interlink/how-to 1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. A listing of your InterLinks displays. 2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays. - + 3. In the **Route propagation** section, click **Attach routing policy**. A pop-up displays. - + 4. Select a routing policy from the drop-down list, and click **Attach policy**. @@ -94,7 +104,7 @@ Once you have attached a VPC and attached a routing policy, you can activate rou 2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays. - + 3. In the **Route propagation** section, use the toggle to turn route propagation **ON**. @@ -142,7 +152,7 @@ It is not possible to modify settings that were defined at the time of creating 5. In the **Attached VPC** section, click **Attach VPC**. A pop-up displays: - + 6. Select one of your existing VPCs from the dropdown list. It must be in the same region as the InterLink. Alternatively, click **+ Create VPC** to create and attach a new VPC. diff --git a/pages/interlink/how-to/create-routing-policy.mdx b/pages/interlink/how-to/create-routing-policy.mdx index c6c5b87777..94b0db7c87 100644 --- a/pages/interlink/how-to/create-routing-policy.mdx +++ b/pages/interlink/how-to/create-routing-policy.mdx @@ -12,6 +12,8 @@ tags: interlink direct-connect allowed-routes route-propagation whitelist range categories: - network --- +import image from './assets/scaleway-create-routing-policy.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -31,7 +33,7 @@ Learn more about routing across an InterLink in our [detailed overview](/interli 3. Click **+Create routing policy**. The **Create a routing policy** wizard displays. - + 4. Enter a name for the policy, or leave the randomly-generated name in place. diff --git a/pages/interlink/how-to/delete-interlink.mdx b/pages/interlink/how-to/delete-interlink.mdx index ed2cac806d..03d983daa0 100644 --- a/pages/interlink/how-to/delete-interlink.mdx +++ b/pages/interlink/how-to/delete-interlink.mdx @@ -12,6 +12,8 @@ tags: interlink direct-connect allowed-routes routing-policy route-propagation w categories: - network --- +import image from './assets/scaleway-interlink-overview-up.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -25,7 +27,7 @@ You can delete your InterLink at any time. Action is required on both the Scalew 2. Click on the InterLink that you want to delete. The InterLink's **Overview** page displays. - + 3. [Deactivate route propagation](/interlink/how-to/configure-interlink/#how-to-deactivate-route-propagation). diff --git a/pages/interlink/how-to/order-interlink.mdx b/pages/interlink/how-to/order-interlink.mdx index bbc411cc8f..400d7530c3 100644 --- a/pages/interlink/how-to/order-interlink.mdx +++ b/pages/interlink/how-to/order-interlink.mdx @@ -12,6 +12,12 @@ tags: interlink direct-connect order hosted partner pop location categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-interlink-diag-simple.webp' +import image2 from './assets/scaleway-order-interlink.webp' +import image3 from './assets/scaleway-interlink-ordering.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -21,11 +27,11 @@ InterLink is Scaleway's product to let you create a secure, private connection b Currently, InterLink is available in **hosted** version only. This means that you must choose a compatible [partner](/interlink/concepts/#partner) to facilitate the physical connection between the external infrastructure and the Scaleway VPC. - + This guide takes you through the process of ordering an InterLink via the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -36,7 +42,7 @@ This guide takes you through the process of ordering an InterLink via the Scalew 2. Click **Order InterLink**. The order wizard displays. - + 3. Select a [connection type](/interlink/concepts/#connection-type), the type of physical InterLink connection. For now, only **hosted** connections are available. @@ -56,7 +62,7 @@ This guide takes you through the process of ordering an InterLink via the Scalew Your InterLink is ordered, and its status briefly shows as `Configuring`, then `Requested`. **You must now contact your chosen partner to request they provision your InterLink from their end.** - + For full details of the provisioning process, including how to contact your partner and what other steps you need to take, see the page [How to complete InterLink provisioning](/interlink/how-to/complete-provisioning/). diff --git a/pages/interlink/quickstart.mdx b/pages/interlink/quickstart.mdx index bcb78ed0ab..087252dd9c 100644 --- a/pages/interlink/quickstart.mdx +++ b/pages/interlink/quickstart.mdx @@ -12,6 +12,18 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-interlink-diag-simple.webp' +import image2 from './assets/scaleway-interlink-ordering.webp' +import image3 from './assets/scaleway-order-interlink.webp' +import image4 from './assets/scaleway-interlink-overview-requesting.webp' +import image5 from './assets/scaleway-interlink-listing.webp' +import image6 from './assets/scaleway-interlink-config.webp' +import image7 from './assets/scaleway-interlink-overview-up.webp' +import image8 from './assets/scaleway-interlink-attach-vpc.webp' +import image9 from './assets/scaleway-attach-routing-policy.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -19,22 +31,22 @@ InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). InterLink is Scaleway's product to let you create a secure, private connection between your external infrastructure, and your Scaleway VPC. This allows you to direct your traffic safely from your Scaleway infrastructure to your on-premises infrastructure, away from the public internet. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization ## How to order an InterLink - + 1. Click **InterLink** in the **Network** section of the [Scaleway console](https://console.scaleway.com) side menu. If you have not already created an InterLink, the product ordering page is displayed. 2. Click **Order InterLink**. The order wizard displays. - + 3. Select a [connection type](/interlink/concepts/#connection-type), the type of physical InterLink connection. For now, only **hosted** connections are available. @@ -60,7 +72,7 @@ Your InterLink is ordered, and its status briefly shows as `Configuring`, then ` 2. Click on the InterLink that you want to finish provisioning. The InterLink's **Overview** page displays. - + 3. Note down the [pairing key](/interlink/concepts/#pairing-key) for your InterLink. This is a unique identification number which the partner will need in order to provision your InterLink. @@ -72,7 +84,7 @@ You can also use the [Get a partner](https://www.scaleway.com/en/developers/api/ Your InterLink will remain in `Requested` status until the partner responds to your request. You can keep track of your InterLink's [status](/interlink/reference-content/statuses/) via the [InterLink listing](https://console.scaleway.com/interlink/links) in the Scaleway console. - + When the partner approves your request, the InterLink moves to `Provisioning` status. This means that the partner has agreed to facilitate your InterLink, and is now preparing the resources and configuration necessary to do so. @@ -86,7 +98,7 @@ If you experience any unexpected statuses, refer to our [information page on Int After your InterLink has been provisioned, a number of configuration steps are necessary to enable traffic to flow over the InterLink. - + ### How to attach a VPC @@ -96,11 +108,11 @@ Attaching an InterLink to a VPC allows you to complete the connection from your 2. Click on the InterLink that you want to configure. The InterLink's **Overview** page displays. - + 3. In the **Attached VPC** section, click **Attach VPC**. A pop-up displays: - + 4. Select one of your existing VPCs from the dropdown list. It must be in the same region as the InterLink. Alternatively, click **+ Create VPC** to create and attach a new VPC. @@ -128,7 +140,7 @@ See the dedicated documentation on [creating a routing policy](/interlink/how-to 3. In the **Route propagation** section, click **Attach routing policy**. A pop-up displays. - + 4. Select a routing policy from the drop-down list, and click **Attach list**. diff --git a/pages/interlink/reference-content/configuring.mdx b/pages/interlink/reference-content/configuring.mdx index 94e96e8a89..adc4980f93 100644 --- a/pages/interlink/reference-content/configuring.mdx +++ b/pages/interlink/reference-content/configuring.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-18 posted: 2024-10-24 --- +import image from './assets/scaleway-interlink-config.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -24,7 +26,7 @@ This document explains the process in full, and gives tips for troubleshooting a ## Configuration overview - + The diagram above shows the four configuration steps necessary for an InterLink. Only when all steps have been completed can traffic flow across the InterLink, connecting the Scaleway VPC to the external (on-premises) infrastructure. diff --git a/pages/interlink/reference-content/overview.mdx b/pages/interlink/reference-content/overview.mdx index da1b384d99..b6937e7116 100644 --- a/pages/interlink/reference-content/overview.mdx +++ b/pages/interlink/reference-content/overview.mdx @@ -13,6 +13,9 @@ dates: validation: 2025-03-18 posted: 2024-10-24 --- +import image from './assets/scaleway-interlink-diag-simple.webp' +import image2 from './assets/scaleway-interlink-diag-tech.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -22,7 +25,7 @@ InterLink is Scaleway's product to let you create a secure, private connection b At its simplest level, InterLink can be understood as a configurable connection between your own infrastructure, and your Scaleway VPC. You can configure details such as available bandwidth, and the routing policy between the two peers: - + ## Types of InterLink @@ -43,7 +46,7 @@ The diagram below shows the architecture of a hosted InterLink. Note that three - The partner's router connects directly to the customer's on-premises infrastructure via a last-mile connection facilitated by the partner. - The customer's infrastructure is hosted in the partner's datacenter, and connects to the partner's router directly. - + ### Self-hosted InterLink diff --git a/pages/interlink/reference-content/provisioning.mdx b/pages/interlink/reference-content/provisioning.mdx index 6139877cf8..606f418a09 100644 --- a/pages/interlink/reference-content/provisioning.mdx +++ b/pages/interlink/reference-content/provisioning.mdx @@ -13,6 +13,9 @@ dates: validation: 2025-03-18 posted: 2024-10-24 --- +import image from './assets/scaleway-interlink-diag-tech.webp' +import image2 from './assets/scaleway-interlink-ordering.webp' + InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). @@ -20,13 +23,13 @@ InterLink is currently in [Public Beta](https://www.scaleway.com/en/betas/). The process of ordering an InterLink has multiple stages: action is required both from Scaleway, the user, and from the selected [partner](/interlink/concepts/#partner). When preparing your InterLink order, you must choose appropriate location (aka **P**oint **o**f **P**resence), partner and region settings to ensure compatibility with your external and Scaleway infrastructure. - + This document explains the provisioning process in full, so you know what to expect when ordering an InterLink, what action is required from all parties, and how to deal with any potential errors. ## Provisioning overview - + The diagram above shows the four steps necessary to provision an InterLink. Only when all steps have been completed will the InterLink move to an **Active** status, ready for traffic to flow. Read more about each step, and possible errors at each stage, in the following sections. diff --git a/pages/iot-hub/api-cli/cli-db-tips-tricks.mdx b/pages/iot-hub/api-cli/cli-db-tips-tricks.mdx index 313f9b1f3c..bf15bcbf47 100644 --- a/pages/iot-hub/api-cli/cli-db-tips-tricks.mdx +++ b/pages/iot-hub/api-cli/cli-db-tips-tricks.mdx @@ -11,6 +11,8 @@ dates: validation: 2025-05-14 tags: iot iot-hub database cli postgresql payload plsql json mysql --- +import Requirements from '@macros/iam/requirements.mdx' + ## Database Routes tips and tricks @@ -26,7 +28,7 @@ This section shows two cases of data manipulation on the PostgreSQL side. 1. The first one converts payloads to a float data type. 2. The second one uses both JSON manipulation and stored plsql functions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -187,7 +189,7 @@ This section presents similar examples using MySQL: - The second one converts payloads to a float data type. - The third one uses both JSON manipulation and MySQL stored functions. - + - Followed the [Getting started with the IoT Hub CLI](/iot-hub/api-cli/getting-started-with-iot-hub-cli/) tutorial - A working MySQL database, with valid credentials (username and password). You can use a [Scaleway Database instance](https://console.scaleway.com/rdb/instances), or any other MySQL instance publicly accessible diff --git a/pages/iot-hub/api-cli/getting-started-with-iot-hub-api.mdx b/pages/iot-hub/api-cli/getting-started-with-iot-hub-api.mdx index 9aaf682fad..962320f5e3 100644 --- a/pages/iot-hub/api-cli/getting-started-with-iot-hub-api.mdx +++ b/pages/iot-hub/api-cli/getting-started-with-iot-hub-api.mdx @@ -11,12 +11,14 @@ dates: validation: 2025-05-14 tags: iot iot-hub io-hub-api api curl mqtt jq json --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial we will use the API through the well known utility [curl](https://curl.haxx.se/). This will show you how to create Hubs and Devices, as well as more advanced features of the Scaleway IoT Hub: Hub Events and Routes. The API reference is here: [IoT API](https://www.scaleway.com/en/developers/api/iot/) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/api-cli/getting-started-with-iot-hub-cli.mdx b/pages/iot-hub/api-cli/getting-started-with-iot-hub-cli.mdx index ce4dfd3daa..9c563e6ec9 100644 --- a/pages/iot-hub/api-cli/getting-started-with-iot-hub-cli.mdx +++ b/pages/iot-hub/api-cli/getting-started-with-iot-hub-cli.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-05-14 tags: IoT Device cli iot-hub --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial we will use the API through the Scaleway command line interface [CLI](https://github.com/scaleway/scaleway-cli#Installation). This will show you how to create Hubs and Devices, as well as more advanced features of the Scaleway IoT Hub: Hub Events and Routes. You can find the API reference documentation at the following link: [IoT API](https://www.scaleway.com/en/developers/api/iot/) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/api-cli/iot-hub-routes.mdx b/pages/iot-hub/api-cli/iot-hub-routes.mdx index bee198b61b..ff67081817 100644 --- a/pages/iot-hub/api-cli/iot-hub-routes.mdx +++ b/pages/iot-hub/api-cli/iot-hub-routes.mdx @@ -11,6 +11,8 @@ dates: validation: 2025-05-14 tags: iot iot-hub mqtt cli s3cmd amazon-s3 --- +import Requirements from '@macros/iam/requirements.mdx' + Routes are integrations with the Scaleway ecosystem: they can forward MQTT messages to Scaleway services. @@ -18,7 +20,7 @@ Routes are integrations with the Scaleway ecosystem: they can forward MQTT messa Find out more about IoT Hub Routes in the [Routes reference page](/iot-hub/reference-content/routes/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -108,7 +110,7 @@ This tutorial covers the **PostgreSQL** database system. You can use a [Scaleway ### Setting up a Database Route - + - A working PostgreSQL database, with valid credentials (username and password) diff --git a/pages/iot-hub/api-cli/migrating-from-api-v1beta1.mdx b/pages/iot-hub/api-cli/migrating-from-api-v1beta1.mdx index 61ff713355..70482cb563 100644 --- a/pages/iot-hub/api-cli/migrating-from-api-v1beta1.mdx +++ b/pages/iot-hub/api-cli/migrating-from-api-v1beta1.mdx @@ -11,8 +11,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/add-device.mdx b/pages/iot-hub/how-to/add-device.mdx index 97c8e1820f..8e1c5f8c4f 100644 --- a/pages/iot-hub/how-to/add-device.mdx +++ b/pages/iot-hub/how-to/add-device.mdx @@ -12,12 +12,18 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_add_device.webp' +import image2 from './assets/scaleway-iothub_device_security.webp' +import image3 from './assets/scaleway-iothub_device_credentials.webp' + A device is a representation of a device or program that is connected to the cloud. Through a hub, it exchanges messages with other devices and cloud services. Devices use the [MQTT](http://mqtt.org/) protocol to send and receive messages. MQTT over WebSocket is also supported through a dedicated [network](/iot-hub/how-to/connect-default-mqtt-network/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -26,13 +32,13 @@ Devices use the [MQTT](http://mqtt.org/) protocol to send and receive messages. 1. Click **IoT Hub** in the **Integration Services** section of the side menu. The list of your IoT Hubs displays. 2. Click the name of the IoT Hub on which you want to add a device. The hub's overview page displays. 3. Click **Add devices** in the devices tab of your hub. - + 4. Enter a **name** for your device. It must be unique among the devices in this hub, and cannot be changed once created. Optionally, set a device description (only for display purposes). 5. Choose a **security setting** for your device. You can either deny or allow insecure connections. - + 6. Click **Add device to hub**. 7. Download the credentials of the device and keep them safe. - + Make sure to download or copy the **Device certificate** and the **Device private key**. These files are required to establish a connection from the device to your hub. For security reasons, the private key is not stored on our side, and you will not be able to access it later. diff --git a/pages/iot-hub/how-to/change-plan.mdx b/pages/iot-hub/how-to/change-plan.mdx index 7dec649466..5a89ccc645 100644 --- a/pages/iot-hub/how-to/change-plan.mdx +++ b/pages/iot-hub/how-to/change-plan.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + If your project grows, you may need to upgrade your IoT Hub to a more powerful version to handle your application load. You can upgrade your hub via the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/connect-default-mqtt-network.mdx b/pages/iot-hub/how-to/connect-default-mqtt-network.mdx index b53431d5fc..e1e87392e9 100644 --- a/pages/iot-hub/how-to/connect-default-mqtt-network.mdx +++ b/pages/iot-hub/how-to/connect-default-mqtt-network.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + The default network, which is automatically created with a hub, is a **MQTT network**. The default network, cannot be deleted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/connect-default-websocket-network.mdx b/pages/iot-hub/how-to/connect-default-websocket-network.mdx index 626083ac4b..dac9dfc142 100644 --- a/pages/iot-hub/how-to/connect-default-websocket-network.mdx +++ b/pages/iot-hub/how-to/connect-default-websocket-network.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Each Hub automatically creates a default WebSocket network, and, like the default network, users cannot delete it. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/create-hub.mdx b/pages/iot-hub/how-to/create-hub.mdx index 360cff44ad..c04ca79693 100644 --- a/pages/iot-hub/how-to/create-hub.mdx +++ b/pages/iot-hub/how-to/create-hub.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + A Hub is the central piece to which Devices can connect to exchange messages, and by which they get access to cloud services. Under the hood, a Hub acts as an MQTT broker, meaning devices use it to publish messages on topics or subscribe to them. Hub Routes allow Devices to push messages to other, non MQTT, services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/create-route.mdx b/pages/iot-hub/how-to/create-route.mdx index 54ebbb0fdf..52d6726dfa 100644 --- a/pages/iot-hub/how-to/create-route.mdx +++ b/pages/iot-hub/how-to/create-route.mdx @@ -12,6 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_routes_add.webp' + Routes allow your IoT Hub to forward messages to non-MQTT destinations. @@ -21,7 +25,7 @@ Currently, the following routes are available: - **Database Route** allowing you to execute queries on a PostgreSQL or MySQL database with the content of your messages. - **Scaleway Object Storage Route** allowing you to store your messages in your Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/) bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +35,7 @@ Currently, the following routes are available: 2. Click the name of the IoT Hub you want to configure. The hub's overview page displays. 3. Click **Routes** to display the routes configuration. 4. Click **Create route** in the routes tab. The **Add a new route** wizard displays. - + 5. Complete the following steps of the wizard: - Enter a name for your route. - Enter the topic filter you want your route to subscribe to. This topic filter can contain wildcards (`+` and `#`). diff --git a/pages/iot-hub/how-to/delete-device.mdx b/pages/iot-hub/how-to/delete-device.mdx index 9f9d2e94c9..203c8d6f50 100644 --- a/pages/iot-hub/how-to/delete-device.mdx +++ b/pages/iot-hub/how-to/delete-device.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/delete-hub.mdx b/pages/iot-hub/how-to/delete-hub.mdx index 62245950ee..bb823df8a8 100644 --- a/pages/iot-hub/how-to/delete-hub.mdx +++ b/pages/iot-hub/how-to/delete-hub.mdx @@ -12,10 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_delete.webp' + If you do not need your IoT Hub anymore, you can remove it from your account via the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -24,7 +28,7 @@ If you do not need your IoT Hub anymore, you can remove it from your account via 1. Click **IoT Hub** in the **Integration Services** section of the side menu. The list of your IoT Hubs displays. 2. Click the name of the IoT Hub you want to delete. The hub's overview page displays. 3. Click **Delete hub** to remove the selected hub from your account. - + Note that deleting your hub will also delete any device added to it. diff --git a/pages/iot-hub/how-to/delete-route.mdx b/pages/iot-hub/how-to/delete-route.mdx index faf66d1274..968818a5eb 100644 --- a/pages/iot-hub/how-to/delete-route.mdx +++ b/pages/iot-hub/how-to/delete-route.mdx @@ -12,6 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_routes_delete.webp' + Routes allow your IoT Hub to forward messages to non-MQTT destinations. @@ -21,7 +25,7 @@ Currently, the following routes are available: - **Database route** allowing you execute queries on a PostgreSQL or MySQL database with the content of your messages. - **Scaleway Object Storage route** allowing you to store your messages in your Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/) bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -32,7 +36,7 @@ Currently, the following routes are available: 2. Click the name of the IoT Hub with the route you want to delete. The hub's overview page displays. 3. Click the **Routes** tab. A list of all your routes displays. 4. Click the icon next to the route you want to delete, and select **Delete** from the drop-down menu. - + A pop-up asks you to confirm the action. 5. Type **DELETE** and then click **Delete route**. diff --git a/pages/iot-hub/how-to/enable-auto-provisioning.mdx b/pages/iot-hub/how-to/enable-auto-provisioning.mdx index bd2db1a026..3d874a6170 100644 --- a/pages/iot-hub/how-to/enable-auto-provisioning.mdx +++ b/pages/iot-hub/how-to/enable-auto-provisioning.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Enabling device auto-provisioning will automatically create missing devices in your hub when they supply valid TLS information. The certificate chain will be verified against the custom certificate authority of the target hub. If there is no device with the same name as the device certificate Common Name (CN), a device with that CN will be created on this hub. @@ -25,7 +27,7 @@ Created devices have the following properties: - **Allow insecure:** False. As the security relies on the use of mTLS, it is not possible to connect with this device using insecure connections. - **Allow multiple connections:** False. The certificate should represent a unique physical device. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/enable-disable-hub.mdx b/pages/iot-hub/how-to/enable-disable-hub.mdx index 0ed3b39292..e1db9f1e3b 100644 --- a/pages/iot-hub/how-to/enable-disable-hub.mdx +++ b/pages/iot-hub/how-to/enable-disable-hub.mdx @@ -12,10 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_enable_disable.webp' + You can enable or disable your IoT Hub from the Scaleway console. This can be useful if you want to do maintenance actions on your hub, or if you want to change the [product plan](/iot-hub/how-to/change-plan/) of your hub. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -24,7 +28,7 @@ You can enable or disable your IoT Hub from the Scaleway console. This can be us 1. Click **IoT Hub** in the **Integration Services** section of the side menu. The list of your IoT Hubs displays. 2. Click the name of the IoT Hub you want to disable or enable. The hub's overview page displays. 3. Toggle the **Enabled**/**Disabled** switch to change the status of your hub. - + 4. Confirm the status change by clicking **Disable hub** or **Enable hub** in the pop-up window. As long as your hub is disabled, you will not be billed. However, your hub's devices will not be able to connect. diff --git a/pages/iot-hub/how-to/provide-own-certificate-authority.mdx b/pages/iot-hub/how-to/provide-own-certificate-authority.mdx index cfdd7534d0..2f81539c5e 100644 --- a/pages/iot-hub/how-to/provide-own-certificate-authority.mdx +++ b/pages/iot-hub/how-to/provide-own-certificate-authority.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + When creating a hub, a Certificate Authority will be automatically created and a certificate will be issued for each device subsequently added. However, you can opt for the hub to use a custom **Certificate Authority** (CA), to enable more complex scenarios. @@ -31,7 +33,7 @@ Switching to a custom Certificate Authority has several benefits: As a security measure to protect certificates, Scaleway does not have access to private keys of custom Certificate Authorities. Therefore, the hub will not issue certificates for a custom Certificate Authority. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/provide-own-device-certificate.mdx b/pages/iot-hub/how-to/provide-own-device-certificate.mdx index 585bd87443..44a44efb79 100644 --- a/pages/iot-hub/how-to/provide-own-device-certificate.mdx +++ b/pages/iot-hub/how-to/provide-own-device-certificate.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + At Scaleway, a certificate is automatically created and attached to a device upon creation, if you have not previously set up your own Certificate Authority. You also have the option of setting up a **specific certificate** for your device. @@ -20,7 +22,7 @@ At Scaleway, a certificate is automatically created and attached to a device upo If you want to use a different Scaleway-managed certificate you can delete the device and create a new one using the same device name. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/renew-device-certificate.mdx b/pages/iot-hub/how-to/renew-device-certificate.mdx index 9937f43621..a9edfa5581 100644 --- a/pages/iot-hub/how-to/renew-device-certificate.mdx +++ b/pages/iot-hub/how-to/renew-device-certificate.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/setup-use-rest-network.mdx b/pages/iot-hub/how-to/setup-use-rest-network.mdx index 4678d321e3..e085e935ba 100644 --- a/pages/iot-hub/how-to/setup-use-rest-network.mdx +++ b/pages/iot-hub/how-to/setup-use-rest-network.mdx @@ -12,10 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_network_modal_rest.webp' + IoT Hub allows you to configure and use [REST](https://en.wikipedia.org/wiki/Representational_state_transfer) networks for your IoT applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -35,7 +39,7 @@ IoT Hub allows you to configure and use [REST](https://en.wikipedia.org/wiki/Rep * Enter a name for your network. * Choose **REST** as the type of network you want to create. * Choose a topic prefix your network should publish to. You may leave this empty. All the messages published to this network will have their topics prefixed with this value. - + 6. Click **Create network**. A summary of the network you created, displays. Take note of the two key parameters: * The network endpoint. * The network secret. This secret will **only be shown once**. We recommend you write it down to avoid losing it. diff --git a/pages/iot-hub/how-to/setup-use-sigfox-network.mdx b/pages/iot-hub/how-to/setup-use-sigfox-network.mdx index 59e565a6d7..ae7192bc0d 100644 --- a/pages/iot-hub/how-to/setup-use-sigfox-network.mdx +++ b/pages/iot-hub/how-to/setup-use-sigfox-network.mdx @@ -12,10 +12,18 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_network_modal_sigfox.webp' +import image2 from './assets/scaleway-iothub_network_sigfox_devicetype_tab.webp' +import image3 from './assets/scaleway-iothub_network_sigfox_devicetype_callbacks.webp' +import image4 from './assets/scaleway-iothub_network_sigfox_devicetype_new_custom_callback.webp' +import image5 from './assets/scaleway-iothub_network_sigfox_devicetype_callback_form.webp' + The [Sigfox](https://www.sigfox.com/en) network type allows devices communicating with the Sigfox protocol to exchange messages with the IoT Hub. Sigfox will collect messages from your devices, and relay them to your IoT Hub. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -40,7 +48,7 @@ The [Sigfox](https://www.sigfox.com/en) network type allows devices communicatin * Enter a name for your network. * Choose Sigfox as the type of network you want to create. * Choose a topic prefix your network should publish to. You may leave this empty. All the messages published to this network will have their topics prefixed with this value. - + 6. Click **Create network**. A summary of the network you created, displays. Take note of the two key parameters: * The network endpoint. * The network secret. Be careful, this secret will **only be shown once**! @@ -53,13 +61,13 @@ Now you have successfully created your Sigfox network, it is time to configure t 1. Log into the [Sigfox backend](https://backend.sigfox.com). 2. Go the **DEVICE TYPE** tab - + 3. Click the **CALLBACKS** entry in the left menu - + 4. Select the **Custom callback** option - + 5. Fill-in the form like the example below. - + Let us go through each field: diff --git a/pages/iot-hub/how-to/simulate-event.mdx b/pages/iot-hub/how-to/simulate-event.mdx index 0d357c7988..cd5f9f9855 100644 --- a/pages/iot-hub/how-to/simulate-event.mdx +++ b/pages/iot-hub/how-to/simulate-event.mdx @@ -12,12 +12,16 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-device-id.webp' + To demonstrate the use of hub Events, the following tutorial allows you to generate an error, and shows you how to receive this error. For more information about hub Events, you can check out the [IoT Hub Events documentation](/iot-hub/reference-content/hubs/#events). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -30,7 +34,7 @@ For more information about hub Events, you can check out the [IoT Hub Events doc 4. Click **Add devices** in the devices tab. The **Create a device** wizard displays. 5. Enter a name for the device (`logger`) and **allow** insecure connections. 6. Click **Add device to hub**. The device's details displays. Take a note of the **device ID**: - + 7. Open a terminal window on your local computer and subscribe to the `$SCW/events/error/#` topic to receive the hub event: ``` mosquitto_sub -h iot.fr-par.scw.cloud -p 1883 -i -t '$SCW/events/error/#' diff --git a/pages/iot-hub/how-to/trigger-functions-from-messages.mdx b/pages/iot-hub/how-to/trigger-functions-from-messages.mdx index 4ed0bfecd1..af94043f54 100644 --- a/pages/iot-hub/how-to/trigger-functions-from-messages.mdx +++ b/pages/iot-hub/how-to/trigger-functions-from-messages.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Function as a Service allows developers to run code without the hassle of managing the server/Instance running it. IoT Hub allows messages to be exchanged between devices and business-specific software. Some or all components of this software can be implemented using Scaleway Serverless Functions, and IoT Hub can be configured to trigger these functions to process messages being exchanged on the hub. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/understand-event-messages.mdx b/pages/iot-hub/how-to/understand-event-messages.mdx index b40baeebc8..9c6ae3ee50 100644 --- a/pages/iot-hub/how-to/understand-event-messages.mdx +++ b/pages/iot-hub/how-to/understand-event-messages.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This section shows you the types of message that can be received in IoT Hub Events. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/iot-hub/how-to/use-mqtt-webclient.mdx b/pages/iot-hub/how-to/use-mqtt-webclient.mdx index fd5b1fc22a..30bee2a507 100644 --- a/pages/iot-hub/how-to/use-mqtt-webclient.mdx +++ b/pages/iot-hub/how-to/use-mqtt-webclient.mdx @@ -13,12 +13,16 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub-webclient.webp' + An MQTT WebClient is embedded in the [Scaleway console](https://console.scaleway.com/iot-hub/hubs). You can use it to connect to your hub as a device and publish and subscribe to topics on the hub without having to set up a command line tool on your computer. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -40,7 +44,7 @@ You can use it to connect to your hub as a device and publish and subscribe to t The message should appear in the **Messages**. - + To learn more about MQTT, refer to [An Introduction to the MQTT protocol](https://www.scaleway.com/en/blog/introduction-to-mqtt-protocol/) blog post. diff --git a/pages/iot-hub/how-to/view-metrics.mdx b/pages/iot-hub/how-to/view-metrics.mdx index 468447a7cd..00d0455e77 100644 --- a/pages/iot-hub/how-to/view-metrics.mdx +++ b/pages/iot-hub/how-to/view-metrics.mdx @@ -12,10 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub_metrics_hub.webp' + Metrics reports the usage of your IoT Hub and devices. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -28,7 +32,7 @@ Metrics reports the usage of your IoT Hub and devices. 3. Click the **Metrics** tab of your hub. The metrics of the Hub are visualized as graph: - + ## How to view device metrics diff --git a/pages/iot-hub/quickstart.mdx b/pages/iot-hub/quickstart.mdx index 52acd1a642..d62eba31f6 100644 --- a/pages/iot-hub/quickstart.mdx +++ b/pages/iot-hub/quickstart.mdx @@ -12,12 +12,17 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-iothub-qs1.webp' +import image2 from './assets/scaleway-iothub-qs2.webp' + [Scaleway IoT Hub](/iot-hub/quickstart/) is a resilient and multi-protocol message broker with export capabilities. Devices can connect to the hub to exchange messages, by which they get access to cloud services. Hub Routes also allow devices to push messages to other, non MQTT, services. In this Quickstart, we show you how to create your first IoT Hub to connect objects, Scaleway services and applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -86,9 +91,9 @@ To exchange messages between our two devices, we are going to open two web-based * Set the topic to `my/first/topic` * Click OK - + 5. Post a message on the **publisher** device. Type the message in the form and click **Publish**: - + You can see in the "Messages" box that the message published by the **publisher** has been received by the **subscriber**. Congratulations, you have successfully configured your first IoT Hub. diff --git a/pages/iot-hub/reference-content/overview.mdx b/pages/iot-hub/reference-content/overview.mdx index 7f234c68e2..41383b7a8a 100644 --- a/pages/iot-hub/reference-content/overview.mdx +++ b/pages/iot-hub/reference-content/overview.mdx @@ -15,12 +15,14 @@ dates: categories: - managed-services --- +import image from './assets/scaleway-iothub-overview.webp' + **IoT Hub** is a managed **message broker** that dispatches messages between **devices**, **services** and **applications** using a publish/subscribe pattern. It allows true hotplug, many-to-many, and asynchronous communications. - + ## Networks diff --git a/pages/ipam/api-cli/set-ip-reverse.mdx b/pages/ipam/api-cli/set-ip-reverse.mdx index 27c262d9ba..6df38dbc04 100644 --- a/pages/ipam/api-cli/set-ip-reverse.mdx +++ b/pages/ipam/api-cli/set-ip-reverse.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-19 posted: 2025-03-19 --- +import Requirements from '@macros/iam/requirements.mdx' + The Scaleway console allows you to [configure reverse DNS](/instances/how-to/configure-reverse-dns/) for flexible IP addresses. @@ -19,7 +21,7 @@ For IPv4 addresses, the console functionality is convenient. However, for IPv6 a You can solve this problem by using the IPAM API to set reverse DNS for individual addresses within your IPv6 block. IPAM is Scaleway's IP Address Manager tool, which acts as a single source of truth for all Scaleway IP addresses. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/ipam/how-to/list-ips.mdx b/pages/ipam/how-to/list-ips.mdx index f07392429d..9110dea790 100644 --- a/pages/ipam/how-to/list-ips.mdx +++ b/pages/ipam/how-to/list-ips.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + **IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. @@ -19,7 +21,7 @@ categories: You can currently use IPAM in the Scaleway console to manage the IP address space of your Scaleway Private Networks. This document shows you how to list the [private IP addresses](/ipam/concepts/#private-ip-address) of all your Scaleway resources attached to Private Networks. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/ipam/how-to/manage-ips.mdx b/pages/ipam/how-to/manage-ips.mdx index 4b57d9354a..0f2b213175 100644 --- a/pages/ipam/how-to/manage-ips.mdx +++ b/pages/ipam/how-to/manage-ips.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-ipam-moreinfo.webp' + IPAM acts as a single source of truth for the IP addresses of your Scaleway resources. You can use IPAM in the console Scaleway console to manage [private IP addresses](/ipam/concepts/#private-ip-address) that are either attached to one of your resources on a Private Network, or [reserved via the IPAM API](https://www.scaleway.com/en/developers/api/ipam/#path-ips-book-a-new-ip). @@ -21,7 +25,7 @@ The management actions currently available include: Learn [how to reserve a private IP address](/ipam/how-to/reserve-ip/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -39,7 +43,7 @@ Learn [how to reserve a private IP address](/ipam/how-to/reserve-ip/). A screen similar to the following displays: - + You can view the following information: - The IP address diff --git a/pages/ipam/how-to/reserve-ip.mdx b/pages/ipam/how-to/reserve-ip.mdx index 15c279700e..a8895af0d2 100644 --- a/pages/ipam/how-to/reserve-ip.mdx +++ b/pages/ipam/how-to/reserve-ip.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-reserve-ip.webp' + **IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. @@ -23,7 +27,7 @@ Currently, only **Instances**, **Elastic Metal servers**, **Load Balancers**, an This page sets out the steps necessary to reserve an IP address with IPAM. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -37,7 +41,7 @@ The procedure is the same, whether you want to use the IP to attach a Scaleway-m 2. Click **Reserve private IP**. The following screen displays: - + 3. Define the parameters for the private IP address you want to reserve: - **IP type**: IPv4 or IPv6 diff --git a/pages/ipam/quickstart.mdx b/pages/ipam/quickstart.mdx index 9774102eb4..27e665cb6e 100644 --- a/pages/ipam/quickstart.mdx +++ b/pages/ipam/quickstart.mdx @@ -12,6 +12,9 @@ dates: categories: - network --- +import image from './assets/scaleway-ipam-moreinfo.webp' +import image2 from './assets/scaleway-reserve-ip.webp' + **IP** **A**ddress **M**anager (IPAM) is Scaleway's tool for planning, tracking and managing the IP address space of Scaleway products. It acts as a single source of truth for the IP addresses of Scaleway resources. @@ -46,7 +49,7 @@ You can currently use IPAM in the Scaleway console to list the [private IP addre A screen similar to the following displays: - + You can view the following information: - The IP address @@ -67,7 +70,7 @@ The procedure is the same, whether you want to use the IP to attach a Scaleway-m 2. Click **Reserve private IP**. The following screen displays: - + 3. Define the parameters for the private IP address you want to reserve: - **IP type**: IPv4 or IPv6 diff --git a/pages/ipam/reference-content/public-connectivity-best-practices.mdx b/pages/ipam/reference-content/public-connectivity-best-practices.mdx index bdaaa766de..88c83e7c3a 100644 --- a/pages/ipam/reference-content/public-connectivity-best-practices.mdx +++ b/pages/ipam/reference-content/public-connectivity-best-practices.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Acls from '@macros/network/acls.mdx' + This document sets out best practices for securing and optimizing public connectivity for your Scaleway resources. @@ -75,7 +77,7 @@ Different products offer different security features and controls to help place ### Load Balancers: ACLs and WAF - + Learn how to use the ACL feature in our [dedicated how-to](/load-balancer/how-to/create-manage-acls/) and go deeper with our [reference documentation](/load-balancer/reference-content/acls/). diff --git a/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx b/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx index 47a42514e0..1c8562dd7b 100644 --- a/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx +++ b/pages/ipam/troubleshooting/cant-delete-pn-reserved-ip.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import image from './assets/scaleway-ipam-release-ip.webp' + You may be attempting to delete a Private Network VPC via the Scaleway console, API, or other developer tool, and see one of the following error messages: @@ -30,7 +32,7 @@ You must release the reserved private IPs from IPAM in order to delete the Priva In the [IPAM section](https://console.scaleway.com/ipam/) of the Scaleway console, use the filters to select the region and VPC of your Private Network. If there are any private IPs reserved for the Private Network, release them. - + If you cannot see any reserved IPs in IPAM, check again that you have correctly used the **filters** to display reserved IPs for a given region / VPC / Private Network. In the console, IPAM shows **only** reserved IPs for the selected filters. There is no overview of all reserved IPs across all your Private Networks. diff --git a/pages/ipam/troubleshooting/index.mdx b/pages/ipam/troubleshooting/index.mdx index 44895dcc07..f67449d087 100644 --- a/pages/ipam/troubleshooting/index.mdx +++ b/pages/ipam/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: IpamProductIcon ## Featured Pages - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/api-cli/create-dek-api-cli.mdx b/pages/key-manager/api-cli/create-dek-api-cli.mdx index 0b961c9d18..68c0cbeeea 100644 --- a/pages/key-manager/api-cli/create-dek-api-cli.mdx +++ b/pages/key-manager/api-cli/create-dek-api-cli.mdx @@ -10,8 +10,10 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/api-cli/encrypt-decrypt-data-with-km-dek.mdx b/pages/key-manager/api-cli/encrypt-decrypt-data-with-km-dek.mdx index f8dffafbce..99bb5662d8 100644 --- a/pages/key-manager/api-cli/encrypt-decrypt-data-with-km-dek.mdx +++ b/pages/key-manager/api-cli/encrypt-decrypt-data-with-km-dek.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to encrypt and decrypt data using your Key Manager [data encryption key](/key-manager/concepts/#data-encryption-key-dek) and [Tink](https://github.com/tink-crypto/tink/tree/master). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx b/pages/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx index 55d53bcbe6..e03ec44730 100644 --- a/pages/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx +++ b/pages/key-manager/api-cli/encrypt-decrypt-keys-with-streaming-aead-tink.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to use Scaleway Key Manager with Tink to securely handle large data streams. Specifically, it uses AEAD, which ensures both encryption and authentication of data, along with associated data (like file paths) that is authenticated but not encrypted. This is important for handling large files efficiently, especially in cases where stream processing is necessary, such as video files or large logs. @@ -21,7 +23,7 @@ Streaming AEAD: This is the cryptographic primitive that handles secure, authent This page shows you how to use the Key Manager Tink extension to encrypt and decrypt large data streams using Authenticated Encryption with Associated Data (AEAD). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/api-cli/manage-keys-with-tink.mdx b/pages/key-manager/api-cli/manage-keys-with-tink.mdx index 4900ac87f7..b673cfe44c 100644 --- a/pages/key-manager/api-cli/manage-keys-with-tink.mdx +++ b/pages/key-manager/api-cli/manage-keys-with-tink.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation page provides information on Key Manager Key Encryption Keys (KEKs) and Data Encryption Keys (DEKs), and how to use them with the Tink Go library. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/how-to/create-km-key.mdx b/pages/key-manager/how-to/create-km-key.mdx index 0e0dc4aab1..acdc6e43d8 100644 --- a/pages/key-manager/how-to/create-km-key.mdx +++ b/pages/key-manager/how-to/create-km-key.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Key Manager allows you to create key encryption keys from the [Scaleway console](https://console.scaleway.com). Key encryption keys can then be used to encrypt and decrypt your encrypted data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/how-to/create-manage-dek.mdx b/pages/key-manager/how-to/create-manage-dek.mdx index a778c7c3a6..ab062c4f03 100644 --- a/pages/key-manager/how-to/create-manage-dek.mdx +++ b/pages/key-manager/how-to/create-manage-dek.mdx @@ -10,6 +10,9 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' +import KeyManagerPlaintextVsCiphertext from '@macros/key-manager/plaintext-vs-ciphertext.mdx' + Scaleway's key Manager allows you to create [data encryption keys (DEK)](/key-manager/concepts/#data-encryption-key-dek) to encrypt and decrypt your [payload](/key-manager/concepts/#payload). @@ -19,7 +22,7 @@ You can then use your Key Manager key to encrypt your DEK. You are responsible for storing your DEKS, as Key Manager does not store them for you. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -38,5 +41,5 @@ You can then use your Key Manager key to encrypt your DEK. - Read our [documentation](/key-manager/reference-content/understanding-key-manager/) to understand Key Manager. 6. Optionally, click **Display plaintext** to make sure that the plaintext does not contain any mistakes. - + 7. Click **Close**. diff --git a/pages/key-manager/how-to/delete-km-keys.mdx b/pages/key-manager/how-to/delete-km-keys.mdx index 4a711f9b14..f052af3c18 100644 --- a/pages/key-manager/how-to/delete-km-keys.mdx +++ b/pages/key-manager/how-to/delete-km-keys.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a Key Manager key. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/how-to/disable-km-keys.mdx b/pages/key-manager/how-to/disable-km-keys.mdx index 25da28619a..e5754ffe29 100644 --- a/pages/key-manager/how-to/disable-km-keys.mdx +++ b/pages/key-manager/how-to/disable-km-keys.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to disable a Key Manager key which is enabled by default. Disabling a key renders it unusable for cryptographic operations by any user and application. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/how-to/retrieve-km-key-id.mdx b/pages/key-manager/how-to/retrieve-km-key-id.mdx index 56c5d07a7b..b259837864 100644 --- a/pages/key-manager/how-to/retrieve-km-key-id.mdx +++ b/pages/key-manager/how-to/retrieve-km-key-id.mdx @@ -10,10 +10,12 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to retrieve the ID of your Key Manager key to encrypt data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - [Created](/key-manager/how-to/create-km-key/) a Key Manager key diff --git a/pages/key-manager/how-to/rotate-kem-keys.mdx b/pages/key-manager/how-to/rotate-kem-keys.mdx index 0aa9d508ef..af4f237ef3 100644 --- a/pages/key-manager/how-to/rotate-kem-keys.mdx +++ b/pages/key-manager/how-to/rotate-kem-keys.mdx @@ -10,12 +10,14 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Key rotation is a critical security practice that ensures that encryption keys are not reused for extended periods of time. Regularly rotating keys helps limit the number of messages encrypted with the same key version. This reduces the risk of exposure if a key is compromised, thus enhancing the overall security and resilience of your system. For symmetric encryption, it is generally recommended to rotate keys every 30 to 90 days. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/key-manager/index.mdx b/pages/key-manager/index.mdx index 48db5b151b..8b748b2df3 100644 --- a/pages/key-manager/index.mdx +++ b/pages/key-manager/index.mdx @@ -48,17 +48,17 @@ meta: ## API/CLI - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -47,7 +50,7 @@ Scaleway's Key Manager allows you to create key encryption keys from the [Scalew - Read our [documentation](/key-manager/reference-content/understanding-key-manager/) to understand Key Manager. 6. Optionally, click **Display plaintext** to make sure that the plaintext does not contain any mistakes. - + 7. Click **Close**. diff --git a/pages/key-manager/reference-content/understanding-key-manager.mdx b/pages/key-manager/reference-content/understanding-key-manager.mdx index 5770349ce3..c5c9ae7d9b 100644 --- a/pages/key-manager/reference-content/understanding-key-manager.mdx +++ b/pages/key-manager/reference-content/understanding-key-manager.mdx @@ -10,12 +10,16 @@ dates: validation: 2025-02-06 posted: 2025-02-06 --- +import KeyManagerEncryption from '@macros/key-manager/encryption.mdx' + +import image from './assets/scaleway-key-manager-schema.webp' + ## How to use Key Manager? We recommend using the keys you store in Key Manager as [key encryption keys (KEK)](/key-manager/concepts/#key-encryption-key-kek), and use them to encrypt and decrypt your [data encryption keys (DEK)](/key-manager/concepts/#data-encryption-key-dek). We do not recommend storing your data encryption keys in Key Manager. - + ## Why use data encryption keys? @@ -78,7 +82,7 @@ The key usage specifies the [encryption algorithm](/key-manager/concepts/#encryp Keys with a key usage set to `symmetric_encryption` are **used to encrypt and decrypt data**. - + The following parameters, in compliance with the [recommendations of the French Cybersecurity Agency (ANSSI)](https://cyber.gouv.fr/publications/mecanismes-cryptographiques), are used when creating and using a key with the `AES-256 GCM` [encryption scheme](/key-manager/concepts/#encryption-scheme). diff --git a/pages/kubernetes/api-cli/changing-control-plane-offer.mdx b/pages/kubernetes/api-cli/changing-control-plane-offer.mdx index 205f599eec..f4d3c097ec 100644 --- a/pages/kubernetes/api-cli/changing-control-plane-offer.mdx +++ b/pages/kubernetes/api-cli/changing-control-plane-offer.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Different Kubernetes [cluster types](/kubernetes/faq/#can-i-choose-the-type-of-control-plane-for-my-cluster) are available. @@ -19,7 +21,7 @@ You can use the CLI to specify your cluster type of choice when [creating a new In this tutorial, we show you how to change your cluster type using the Scaleway CLI (v2). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/api-cli/cluster-monitoring.mdx b/pages/kubernetes/api-cli/cluster-monitoring.mdx index c6266bb444..a7589be0c0 100644 --- a/pages/kubernetes/api-cli/cluster-monitoring.mdx +++ b/pages/kubernetes/api-cli/cluster-monitoring.mdx @@ -12,6 +12,23 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_prom_dashboard.webp' +import image2 from './assets/scaleway_prom2.webp' +import image3 from './assets/scaleway_prom3.webp' +import image4 from './assets/scaleway_prom5.webp' +import image5 from './assets/scaleway_grafana_login.webp' +import image6 from './assets/scaleway_grafana_home.webp' +import image7 from './assets/scaleway_grafana_datasource.webp' +import image8 from './assets/scaleway_grafana_import.webp' +import image9 from './assets/scaleway_grafana_dash_datasource.webp' +import image10 from './assets/scaleway_grafana_dashboard.webp' +import image11 from './assets/scaleway_monito3.webp' +import image12 from './assets/scaleway_loki1.webp' +import image13 from './assets/scaleway_loki2.webp' +import image14 from './assets/scaleway_loki3.webp' + Kubernetes Kapsule is fully integrated with Scaleway's [Observability Cockpit](/cockpit/quickstart/). @@ -19,7 +36,7 @@ categories: The following content is provided for informational purposes only. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -73,17 +90,17 @@ Deploy the Prometheus stack in a dedicated Kubernetes [namespace](https://kubern kubectl --namespace monitoring port-forward $POD_NAME 9090 ``` 6. Access the Prometheus dashboard using the following URL: [http://localhost:9090](http://localhost:9090) - + 7. Verify that both `node-exporter` and `kube-state-metrics` metrics are correctly scrapped by Prometheus: * The `node-exporter` metrics begin with “`node_`” - + * The `kube-state-metrics` begin with “`kube_`” - + 8. Prometheus is capable of generating graphs on its own. You can test the feature by choosing metrics to analyze directly in the application: - + ## Deploying Grafana @@ -114,22 +131,22 @@ Deploy `Grafana` to display the `Prometheus` metrics in some pre-defined dashboa Forwarding from [::1]:3000 -> 3000 ``` 4. Open the Grafana Web Interface in a web browser at: `http://localhost:3000`. The login screen displays. Enter the user `admin` and the password recovered in step 2: - + The welcome screen displays and invites you to complete the configuration of Grafana. 5. Click **Add data source** to configure a new data source: - + 6. Choose **Prometheus** as data source from the list of available options. 7. Enter the details of the data source. You can leave the default settings and add the data source: `http://prometheus-server`. Click **Test & Save** to validate the connection to Prometheus and to save the settings: - + 8. Click **+** and then **Import** to import a ready-to-use dashboard from the Grafana website. To create a dashboard that uses *kube-state-metrics*, import the dashboard number [8588](https://grafana.com/grafana/dashboards/8588) and get information about your Deployment, StatefulSet and DaemonSet: - + 9. Choose `Prometheus` as data source and click **Import**. - + 10. Access the dashboard with metrics for Deployement, StatefulSet and DaemonSet: - + 11. You can also configure additional dashboards, for example, the node exporter full dashboard ([1860](https://grafana.com/grafana/dashboards/1860)) to display a dashboard with system metrics for each Kubernetes node: - + ## Deploying Loki @@ -207,10 +224,10 @@ The `loki` application is not included in the default Helm repositories. Forwarding from [::1]:3000 -> 3000 ``` 8. Access [http://localhost:3000](http://localhost:3000) to reach the Grafana interface. Log in using the admin user and the password you got above. - + 9. Add the Loki source to Grafana (`http://loki-stack.loki-stack:3100`). - + 10. Check you can access your logs using the explore tab in Grafana: - + You now have a Loki stack up and running. All your pods’ logs will be stored in Loki and you will be able to view and query your applications’ logs in Grafana. Refer to the [Loki documentation](https://grafana.com/docs/features/datasources/loki/), if you want to learn more about querying the Loki data source. \ No newline at end of file diff --git a/pages/kubernetes/api-cli/creating-managing-kubernetes-lifecycle-cliv2.mdx b/pages/kubernetes/api-cli/creating-managing-kubernetes-lifecycle-cliv2.mdx index 341e4da9a1..1bbf371231 100644 --- a/pages/kubernetes/api-cli/creating-managing-kubernetes-lifecycle-cliv2.mdx +++ b/pages/kubernetes/api-cli/creating-managing-kubernetes-lifecycle-cliv2.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Kubernetes (K8s) Kapsule provides you with a managed environment to create, configure and run a cluster of pre-configured machines for containerized applications. You will be able to create clusters without the complexity of managing the infrastructure. @@ -21,7 +23,7 @@ You can [create](/kubernetes/how-to/create-cluster/) and [manage](/kubernetes/ho [The Scaleway command line interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and is an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and manage Kubernetes clusters. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/api-cli/external-secrets-kubernetes.mdx b/pages/kubernetes/api-cli/external-secrets-kubernetes.mdx index ee57f29556..6cb70048bd 100644 --- a/pages/kubernetes/api-cli/external-secrets-kubernetes.mdx +++ b/pages/kubernetes/api-cli/external-secrets-kubernetes.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-07-01 posted: 2024-12-24 --- +import Requirements from '@macros/iam/requirements.mdx' + ## External Secrets - Overview @@ -19,7 +21,7 @@ dates: In this tutorial you will learn how to deploy External Secrets and its services on [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule), the managed Kubernetes service from Scaleway. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/api-cli/managing-storage.mdx b/pages/kubernetes/api-cli/managing-storage.mdx index 790614e951..0a80f161d6 100644 --- a/pages/kubernetes/api-cli/managing-storage.mdx +++ b/pages/kubernetes/api-cli/managing-storage.mdx @@ -12,10 +12,12 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + The [Scaleway Block Storage volume](https://www.scaleway.com/en/block-storage/) Container Storage Interface (CSI) driver is an implementation of the [CSI interface](https://github.com/container-storage-interface/spec/blob/master/spec.md) to provide a way to manage Scaleway block volumes through a container orchestration system, like Kubernetes. It is installed by default on every Kubernetes Kapsule and Kosmos cluster. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/api-cli/managing-tags.mdx b/pages/kubernetes/api-cli/managing-tags.mdx index affa11611d..b13f44a0d4 100644 --- a/pages/kubernetes/api-cli/managing-tags.mdx +++ b/pages/kubernetes/api-cli/managing-tags.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + The Scaleway Cloud Controller Manager (CCM) will also synchronize the tags of Scaleway Instances to Kubernetes labels on the nodes. @@ -20,7 +22,7 @@ The Scaleway Cloud Controller Manager (CCM) will also synchronize the tags of Sc This feature applies to Kosmos Scaleway pools as well. However, note that this functionality does not extend to `multi-cloud` pools or external nodes outside of the Scaleway infrastructure. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/access-audit-logs.mdx b/pages/kubernetes/how-to/access-audit-logs.mdx index 0d639b2b1c..94f84ba5a5 100644 --- a/pages/kubernetes/how-to/access-audit-logs.mdx +++ b/pages/kubernetes/how-to/access-audit-logs.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule and Kosmos control plane metrics and logs are integrated into Cockpit, providing you with a centralized hub for monitoring the control plane, nodes, managed resources, and cluster system applications. @@ -37,7 +39,7 @@ All logs are centralized in [Cockpit](/cockpit/quickstart/). Monitoring calls to the `kube-apiserver` is a matter of security compliance and perhaps a hard requirement for some of the certifications you are keen to obtain. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/access-kubernetes-dashboard.mdx b/pages/kubernetes/how-to/access-kubernetes-dashboard.mdx index 53af11b056..f31875f23a 100644 --- a/pages/kubernetes/how-to/access-kubernetes-dashboard.mdx +++ b/pages/kubernetes/how-to/access-kubernetes-dashboard.mdx @@ -12,8 +12,10 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/connect-cluster-kubectl.mdx b/pages/kubernetes/how-to/connect-cluster-kubectl.mdx index 104a68fd88..352b60bb7b 100644 --- a/pages/kubernetes/how-to/connect-cluster-kubectl.mdx +++ b/pages/kubernetes/how-to/connect-cluster-kubectl.mdx @@ -12,12 +12,14 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Once your [cluster is created](/kubernetes/how-to/create-cluster/), you can install a `kubeconfig` file using Scaleway's command-line tool on your local machine to manage your Kubernetes cluster. You can use this with `kubectl`, the Kubernetes command-line tool, allowing you to run commands against your Kubernetes cluster. This enables you to deploy applications, inspect and manage cluster resources, and view logs directly from your local machine. - + - A [Scaleway account](https://console.scaleway.com) logged into the console. - [Owner status](https://console.scaleway.com) or [IAM permissions](/iam/concepts/#permission) to perform actions in the intended Organization. diff --git a/pages/kubernetes/how-to/create-cluster.mdx b/pages/kubernetes/how-to/create-cluster.mdx index 8bcd26bbad..cbc57a44b4 100644 --- a/pages/kubernetes/how-to/create-cluster.mdx +++ b/pages/kubernetes/how-to/create-cluster.mdx @@ -13,6 +13,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Kubernetes Kapsule provides a managed environment for creating, configuring, and operating a cluster of preconfigured nodes for containerized applications. This service allows you to deploy [Kubernetes](https://kubernetes.io) clusters without the complexity of managing the underlying infrastructure. @@ -22,7 +24,7 @@ Key benefits include: To facilitate cluster administration, Scaleway provides a `.kubeconfig` file, enabling you to manage your cluster locally using `kubectl`. This tool is essential for executing commands against Kubernetes clusters. - + - A Scaleway account with access to the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/create-kosmos-cluster.mdx b/pages/kubernetes/how-to/create-kosmos-cluster.mdx index ec1ab03801..0858a39442 100644 --- a/pages/kubernetes/how-to/create-kosmos-cluster.mdx +++ b/pages/kubernetes/how-to/create-kosmos-cluster.mdx @@ -13,10 +13,12 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kosmos provides an alternative to a classic [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule). With Kubernetes Kosmos, you can create a Kubernetes cluster comprising both managed Scaleway Instances (with autohealing and autoscaling) and external instances and servers from any other cloud provider. Scaleway ensures the high availability of your services globally, across different zones, regions, and providers. In addition to the Kubernetes Kapsule pricing, you are charged for the Kubernetes Kosmos control plane and an additional fee for managed external nodes. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/delete-cluster.mdx b/pages/kubernetes/how-to/delete-cluster.mdx index db7b8f9bc5..572f4dee20 100644 --- a/pages/kubernetes/how-to/delete-cluster.mdx +++ b/pages/kubernetes/how-to/delete-cluster.mdx @@ -12,8 +12,10 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/deploy-image-from-container-registry.mdx b/pages/kubernetes/how-to/deploy-image-from-container-registry.mdx index 52414029b9..6186d50bcf 100644 --- a/pages/kubernetes/how-to/deploy-image-from-container-registry.mdx +++ b/pages/kubernetes/how-to/deploy-image-from-container-registry.mdx @@ -12,6 +12,8 @@ dates: categories: - container-registry --- +import Requirements from '@macros/iam/requirements.mdx' + In this how-to guide you learn how to create and push a container image to the Scaleway [Container Registry](/container-registry/concepts/#container-registry) and how to use it on [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule). @@ -19,7 +21,7 @@ A container image consists of several bundled files, which encapsulate an applic The generated Docker images are stored in a private Docker registry using the Scaleway [Container Registry](/container-registry/concepts/#container-registry) product. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/deploy-ingress-controller.mdx b/pages/kubernetes/how-to/deploy-ingress-controller.mdx index fefaad747a..38e267eefb 100644 --- a/pages/kubernetes/how-to/deploy-ingress-controller.mdx +++ b/pages/kubernetes/how-to/deploy-ingress-controller.mdx @@ -12,10 +12,12 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + An [ingress controller](/kubernetes/concepts/#ingress-controller) is an entry point that ingests your HTTP/HTTPS traffic and dispatches it to your services. More precisely, it is a reverse proxy that will dynamically configure itself and will forward HTTP/HTTPS traffic to your services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/edit-cluster.mdx b/pages/kubernetes/how-to/edit-cluster.mdx index 002a2dd0a7..2e612c8990 100644 --- a/pages/kubernetes/how-to/edit-cluster.mdx +++ b/pages/kubernetes/how-to/edit-cluster.mdx @@ -12,10 +12,12 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + You can manage and edit the parameters of your cluster from the [Scaleway console](https://console.scaleway.com) or by using the [API](https://www.scaleway.com/en/developers/). Here, we show you how to edit from the console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/edit-kosmos-cluster.mdx b/pages/kubernetes/how-to/edit-kosmos-cluster.mdx index 9dcb181202..fdc7622e01 100644 --- a/pages/kubernetes/how-to/edit-kosmos-cluster.mdx +++ b/pages/kubernetes/how-to/edit-kosmos-cluster.mdx @@ -12,6 +12,12 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-kubernetes-kubernetesexternalnoderegister.webp' +import image2 from './assets/scaleway-kosmos-add-application.webp' +import image3 from './assets/scaleway-kosmos-generate-api-key.webp' + You can add nodes and pools to your Kosmos cluster from the [Scaleway console](https://console.scaleway.com) or by using the [API](https://www.scaleway.com/en/developers/). Here, we show you how to edit from the console. @@ -23,7 +29,7 @@ You can add nodes and pools to your Kosmos cluster from the [Scaleway console](h Nodes from multi-cloud pools cannot benefit from the autohealing and autoscaling features of Scaleway Kapsule pool. Since Scaleway does not have access to your other providers’ accounts, it is not possible to carry out actions such as automatic deletion, creation, and reboot of external nodes. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -50,11 +56,11 @@ In order to add external nodes to your multi-cloud cluster, you must first [crea 1. Click **IAM & API keys** on the top-right drop-down menu of the Scaleway console. The [Identity and Access Management dashboard](https://console.scaleway.com/iam/) displays. 2. [Create an IAM Policy](/iam/how-to/create-policy/) with the `KubernetesExternalNodeRegister` PermissionSet only. - + 3. [Create an IAM Application](/iam/how-to/create-application/) linked with the policy created in the previous step. - + 4. [Create a new API key](/iam/how-to/create-api-keys/) linked to the IAM application created in the previous step. - + Identity and Access Management (IAM) allows you to share access to the management of your Scaleway resources and Organization settings, in a controlled and secure manner. For more information, refer to our [dedicated IAM documentation](/iam/quickstart/). diff --git a/pages/kubernetes/how-to/enable-disable-ssh.mdx b/pages/kubernetes/how-to/enable-disable-ssh.mdx index 0d90d0000c..f3f0b6d7ac 100644 --- a/pages/kubernetes/how-to/enable-disable-ssh.mdx +++ b/pages/kubernetes/how-to/enable-disable-ssh.mdx @@ -12,12 +12,14 @@ dates: categories: - containers --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule clusters are provisioned with a default security group as standard. Clusters deployed prior to May 2023 allow inbound traffic to the nodes.

Since May 2023, each Kapsule cluster comes with a default security group implementing an inbound `DROP ALL` policy, effectively blocking all incoming connections by default.

To activate the preinstalled SSH server for node access within the cluster, it is necessary to manually [configure a custom rule](/instances/how-to/use-security-groups/#how-to-edit-a-security-group) in the cluster's security group to allow inbound traffic on TCP port 22. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/enable-easy-deploy.mdx b/pages/kubernetes/how-to/enable-easy-deploy.mdx index 39888da22b..f50652dc0e 100644 --- a/pages/kubernetes/how-to/enable-easy-deploy.mdx +++ b/pages/kubernetes/how-to/enable-easy-deploy.mdx @@ -12,6 +12,15 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-kubernetes-application-library.webp' +import image2 from './assets/scaleway-kubernetes-yaml-edit.webp' +import image3 from './assets/scaleway-kubernetes-kubectl-all.webp' +import image4 from './assets/scaleway-kubernetes-wordpress.webp' +import image5 from './assets/scaleway-update-container.webp' +import image6 from './assets/scaleway-kubernetes-edit-application.webp' + The Easy Deploy feature allows you to pull images directly from [Scaleway Container Registry](/container-registry/concepts/#container-registry), instantly deploying containerized applications in your [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule) and [Kubernetes Kosmos](/kubernetes/concepts/#kubernetes-kosmos) clusters. @@ -19,7 +28,7 @@ You can also deploy off-the-shelf applications pre-configured for Scaleway produ **With only the basic options to set, you can use Kubernetes Kapsule or Kosmos without needing to manage your `.yaml` manifests.** - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -87,11 +96,11 @@ You can also deploy off-the-shelf applications pre-configured for Scaleway produ * After selecting **Application Library**, enter a name for your container as well as the Kubernetes namespace on which the deployment will run. By default, the application is deployed on the `default` namespace. - + * Search and select the application you want to deploy from our library. For example, you can choose to deploy the WordPress application. A default `yaml` configuration will preload to show the specifics defaults values of the application. You can modify or add values to the `yaml` as you see fit. - + * Using `scw-bssd` Storage type will imply the creation of Scaleway Block Storage resources by your Kubernetes cluster, having an impact on your final invoice. * Using `LoadBalancer` service will imply the creation of a Scaleway Load Balancer, having an impact on your final invoice. @@ -100,10 +109,10 @@ You can also deploy off-the-shelf applications pre-configured for Scaleway produ * If you created a LoadBalancer to expose your application, use the `kubectl` command to list the services of your cluster and get the LoadBalancer external IP. - + * Get the Load Balancer's external IP and use it in your web browser to access your application (WordPress in this case) - + We provide dedicated tutorials for deployment of the most popular applications using Easy Deploy: @@ -120,12 +129,12 @@ You can also deploy off-the-shelf applications pre-configured for Scaleway produ 2. From the drop-down menu, select the geographical region you want to manage. 3. Click next to the container you wish to edit, then click **Edit** in the menu. A pop-up displays with the configuration options. 4. When modifying an application deployed from **Container Registry**, modify the container parameters according to your requirements, then click **Update container** to conclude. - + It is not possible to modify a container **type**. If you wish to use a different type, you must create a new container. 5. When modifying an application deployed from the **Application Library**, modify the application configuration according to your requirements, then click **Update and deploy** to conclude. - + ## How to delete an application diff --git a/pages/kubernetes/how-to/manage-allowed-ips.mdx b/pages/kubernetes/how-to/manage-allowed-ips.mdx index 650bd337f6..8d4cc6c6fd 100644 --- a/pages/kubernetes/how-to/manage-allowed-ips.mdx +++ b/pages/kubernetes/how-to/manage-allowed-ips.mdx @@ -12,12 +12,14 @@ dates: categories: - containers --- +import Requirements from '@macros/iam/requirements.mdx' + Restricting IPs on Kubernetes Kapsule or Kosmos clusters enhances security by limiting access to only trusted sources. Since only IP addresses and networks specified by you can interact with your clusters, you reduce the risk of unauthorized access and potential attacks. The default entry `0.0.0.0/0` enables any host to establish a connection. - + - A Scaleway account logged into the [Scaleway console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing actions in the intended Organization diff --git a/pages/kubernetes/how-to/manage-node-pools.mdx b/pages/kubernetes/how-to/manage-node-pools.mdx index 41fb10fdcf..b579423c6d 100644 --- a/pages/kubernetes/how-to/manage-node-pools.mdx +++ b/pages/kubernetes/how-to/manage-node-pools.mdx @@ -12,10 +12,12 @@ dates: categories: - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation provides step-by-step instructions on how to manage Kubernetes Kapsule node pools using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/monitor-cluster.mdx b/pages/kubernetes/how-to/monitor-cluster.mdx index 8d4b6e3897..fb096ca5ee 100644 --- a/pages/kubernetes/how-to/monitor-cluster.mdx +++ b/pages/kubernetes/how-to/monitor-cluster.mdx @@ -12,6 +12,11 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-k8s-cluster-metrics.webp' +import image2 from './assets/scaleway-k8s-cp-logs.webp' + Scaleway's observability Cockpit provides automated monitoring of your Kubernetes cluster. As Kubernetes environments grow in complexity, monitoring becomes crucial for optimal performance. Visualization of the clusters' metrics is available in a hosted Grafana. @@ -31,7 +36,7 @@ Grafana's rich visualizations and ease of use make it an ideal choice. Cockpit o **Security and compliance**: For enhanced security and compliance, Kapsule provides audit logs natively within Cockpit. Learn more in the [audit logs documentation](/kubernetes/how-to/access-audit-logs/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -48,7 +53,7 @@ Grafana's rich visualizations and ease of use make it an ideal choice. Cockpit o 2. Click **Visualize Scaleway data**. The Grafana interface opens in a new browser tab. 3. Log into Grafana using your [Grafana credentials](/cockpit/how-to/retrieve-grafana-credentials/). The list of your Cockpit dashboards displays. 4. Click **Kubernetes cluster overview** in the list of dashboards. A status overview of your cluster displays. This dashboard allows you to monitor multiple components of your Kubernetes cluster: control-plane, nodes, managed resources and cluster system applications. - + Select the cluster you want to display from the drop-down list at the top of the page to change the currently displayed cluster. @@ -72,7 +77,7 @@ For scenarios where you require consistent and predictable performance, along wi Currently, no logs from the `kube-apiserver` are sent to your Cockpit. - + Select the cluster you want to display from the drop-down list at the top of the page to change the currently displayed cluster. diff --git a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx index 333f527d28..557b8c4758 100644 --- a/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx +++ b/pages/kubernetes/how-to/monitor-data-plane-with-cockpit.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-27 posted: 2025-01-17 --- +import Requirements from '@macros/iam/requirements.mdx' + You can now send **data plane** logs from your [Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/) or [Kosmos](https://www.scaleway.com/en/kubernetes-kosmos/) clusters to [Cockpit](https://www.scaleway.com/en/cockpit/), providing centralized, real-time access to application and system logs. Reduce complexity and manual work thanks to this integration, powered by a **Promtail** deployment via [Easy Deploy](/kubernetes/how-to/enable-easy-deploy/). @@ -24,7 +26,7 @@ This feature allows you to: This feature does incur costs based on the volume of logs ingested. Refer to [Cockpit FAQ](/cockpit/faq/#how-am-i-billed-for-using-cockpit-with-custom-data) for more details and best practices to avoid unexpected bills. - + - A running [Kapsule](/kubernetes/how-to/create-cluster/) or [Kosmos](/kubernetes/how-to/create-kosmos-cluster/) cluster. - An API Key with [IAM permissions](/iam/reference-content/permission-sets/) to: diff --git a/pages/kubernetes/how-to/recover-space-etcd.mdx b/pages/kubernetes/how-to/recover-space-etcd.mdx index 3d4c982a04..eb714e5817 100644 --- a/pages/kubernetes/how-to/recover-space-etcd.mdx +++ b/pages/kubernetes/how-to/recover-space-etcd.mdx @@ -12,12 +12,14 @@ dates: categories: - containers --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule clusters have quotas on the space they can occupy on an etcd database. See Kapsule [cluster-types](https://api.scaleway.com/k8s/v1/regions/fr-par/cluster-types) for details on each offer. You can see your current cluster space consumption at any time in your cluster grafana dashboard (`Etcd disk usage` panel). This guide helps you to free up space on your database to avoid reaching this limit. - + - [Created](/kubernetes/how-to/create-cluster/) a Kubernetes Kapsule cluster - [Downloaded](/kubernetes/how-to/connect-cluster-kubectl/) the Kubeconfig diff --git a/pages/kubernetes/how-to/upgrade-kubernetes-version.mdx b/pages/kubernetes/how-to/upgrade-kubernetes-version.mdx index d5c522b7fe..230b93cecd 100644 --- a/pages/kubernetes/how-to/upgrade-kubernetes-version.mdx +++ b/pages/kubernetes/how-to/upgrade-kubernetes-version.mdx @@ -12,12 +12,16 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-upgrade-cluster-new.webp' + You can either upgrade your Kubernetes Kapsule cluster [directly from the Scaleway console](#upgrading-a-kapsule-cluster-from-the-scaleway-console), or upgrade your cluster to the next minor version by [using the CLI](#upgrading-a-kapsule-cluster-to-the-next-minor-version-using-the-cli). The CLI section of this how-to guide also provides additional mandatory information for checking important components before proceeding with the upgrade of your cluster. ## Upgrading a Kapsule cluster from the Scaleway console - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -27,7 +31,7 @@ You can either upgrade your Kubernetes Kapsule cluster [directly from the Scalew 2. From the drop-down menu, select the geographical region you want to manage. 3. Click the cluster name you wish to upgrade the Kubernetes version for. The cluster information page displays. 4. Click **Upgrade** next to the **Kubernetes version** of your cluster. A pop-up displays. - + 5. Select the latest patch or next minor version to upgrade to. Tick the **Upgrade cluster node pools as well** checkbox if you want to upgrade the version of Kubernetes on the node pools in your cluster to the same version. Be careful when upgrading the Kubernetes versions of your node pools, as it may lead to data loss on data stored locally on any node. @@ -42,7 +46,7 @@ You can either upgrade your Kubernetes Kapsule cluster [directly from the Scalew ## Upgrading a Kapsule cluster to the next minor version using the CLI - + - A working [CLI](https://github.com/scaleway/scaleway-cli) with your credentials set up diff --git a/pages/kubernetes/how-to/use-nvidia-gpu-operator.mdx b/pages/kubernetes/how-to/use-nvidia-gpu-operator.mdx index 3e5cd74a30..5d443ae60d 100644 --- a/pages/kubernetes/how-to/use-nvidia-gpu-operator.mdx +++ b/pages/kubernetes/how-to/use-nvidia-gpu-operator.mdx @@ -13,13 +13,15 @@ categories: - containers - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule and Kosmos support NVIDIA's official Kubernetes operator for all GPU pools. This operator is compatible with all Scaleway [GPU Instance](https://www.scaleway.com/en/gpu-instances/) offers. The GPU operator is set up for all GPU pools created in Kubernetes Kapsule and Kosmos, providing automated installation of all required software on GPU worker nodes, such as the device plugin, container toolkit, GPU drivers etc. For more information, refer to [the GPU operator overview](https://docs.nvidia.com/datacenter/cloud-native/gpu-operator/latest/overview.html). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/how-to/use-scratch-storage-h100.mdx b/pages/kubernetes/how-to/use-scratch-storage-h100.mdx index 58bbc36fff..157b756947 100644 --- a/pages/kubernetes/how-to/use-scratch-storage-h100.mdx +++ b/pages/kubernetes/how-to/use-scratch-storage-h100.mdx @@ -13,6 +13,8 @@ categories: - containers - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + [Scratch storage](/gpu/concepts/#scratch-storage) is ephemeral storage allocated to H100 and L40S GPU Instances (up to 6 TB) and crucial for handling temporary data in high-performance computing environments, especially when working with GPUs like the H100. Kubernetes, a powerful container orchestration platform, can be configured to make optimal use of scratch storage for improved performance. @@ -25,7 +27,7 @@ Its utility spans multiple use cases, including but not limited to: Design your workloads or applications to take advantage of the fast and temporary nature of Scratch storage. Consider configuring your applications to store intermediate or temporary data in the Scratch storage path. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/index.mdx b/pages/kubernetes/index.mdx index 6da667c0bf..52c281cad1 100644 --- a/pages/kubernetes/index.mdx +++ b/pages/kubernetes/index.mdx @@ -48,17 +48,17 @@ meta: ## Tutorials - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/reference-content/exposing-services.mdx b/pages/kubernetes/reference-content/exposing-services.mdx index 0e09bdba74..77b2560eb7 100644 --- a/pages/kubernetes/reference-content/exposing-services.mdx +++ b/pages/kubernetes/reference-content/exposing-services.mdx @@ -12,6 +12,10 @@ dates: categories: - kubernetes --- +import image from './assets/scaleway-node-port-diagram.webp' +import image2 from './assets/scaleway-l-b-diagram.webp' +import image3 from './assets/scaleway-ingress-contr-diagram.webp' + By default, Kubernetes clusters are not exposed to the internet. This prevents external users from being able to access the application deployed in your cluster. @@ -38,7 +42,7 @@ Our [webinar](https://www.youtube.com/watch?v=V0uKqYXJRF4) may also be useful to ## NodePort Service - + For more information and practical help with creating a NodePort Service, check out the following resources: @@ -48,7 +52,7 @@ For more information and practical help with creating a NodePort Service, check ## LoadBalancer Service - + For more information and practical help with creating a LoadBalancer Service, check out the following resources: @@ -58,7 +62,7 @@ For more information and practical help with creating a LoadBalancer Service, ch ## Ingress - + For more information and practical help with setting up ingress, check out the following resources: diff --git a/pages/kubernetes/reference-content/introduction-to-kubernetes.mdx b/pages/kubernetes/reference-content/introduction-to-kubernetes.mdx index c7e8b17c30..2fe4ec1fe0 100644 --- a/pages/kubernetes/reference-content/introduction-to-kubernetes.mdx +++ b/pages/kubernetes/reference-content/introduction-to-kubernetes.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import image from './assets/scaleway-deployment_evo.webp' + Kubernetes (K8s) is an open-source platform for managing containerized workloads and services. Google initially developed the project, and it was made publicly available in 2014. Since then, it has a vast, rapidly growing ecosystem. The name Kubernetes derives from the ancient Greek word meaning helmsman or pilot. @@ -21,7 +23,7 @@ This page explains the concept and the different compartments of Kubernetes. To understand why Kubernetes and containerized deployment is so useful for nowadays workloads, let us go back in time and have a view on how deployment has evolved: - + During the **traditional deployment era**, organizations ran applications directly on physical servers. There was no way to control the resources an application may consume, causing resource allocation issues. If an application consumed most of the resources of the server it ran on, this high load might have caused performance issues on other applications running on the same physical server. diff --git a/pages/kubernetes/reference-content/kubernetes-cheatsheet.mdx b/pages/kubernetes/reference-content/kubernetes-cheatsheet.mdx index 5cb786d358..92d9e68bc6 100644 --- a/pages/kubernetes/reference-content/kubernetes-cheatsheet.mdx +++ b/pages/kubernetes/reference-content/kubernetes-cheatsheet.mdx @@ -11,14 +11,18 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-kubernetes-cheatsheet.webp' + This page shows the most common `kubectl` commands for creating and managing Scaleway Kapsule and Kosmos clusters. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - + This content is also available as a printable PDF file. Click the link below to download: diff --git a/pages/kubernetes/reference-content/kubernetes-control-plane-offers.mdx b/pages/kubernetes/reference-content/kubernetes-control-plane-offers.mdx index 257d38b9c1..11503245ba 100644 --- a/pages/kubernetes/reference-content/kubernetes-control-plane-offers.mdx +++ b/pages/kubernetes/reference-content/kubernetes-control-plane-offers.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import image from './assets/scaleway-dcp-detailed.webp' + On a managed Kubernetes service such as Kapsule or Kosmos, Scaleway is responsible for overseeing the Kubernetes control plane. @@ -43,7 +45,7 @@ Whether you are seeking a mutualized environment or a dedicated control plane, w * The size of the etcd key value store is limited to 55 MB and 200 MB, for mutualized and dedicated control planes, respectively. You can view the usage of your control plane’s etcd in Cockpit. - + ## Dedicated control plane conditions diff --git a/pages/kubernetes/reference-content/kubernetes-decision-tree.mdx b/pages/kubernetes/reference-content/kubernetes-decision-tree.mdx index 40590956d8..dbbb279327 100644 --- a/pages/kubernetes/reference-content/kubernetes-decision-tree.mdx +++ b/pages/kubernetes/reference-content/kubernetes-decision-tree.mdx @@ -12,10 +12,12 @@ dates: categories: - kubernetes --- +import image from './assets/DecisionTreeKubernetes-DocumentationWebsite.webp' + This page helps you evaluate your level of knowledge about Kubernetes and provides comprehensive documentation to help you understand the various offerings, integrations, tools, and usage. - + This content is also available as a printable PDF file. Click the link below to download it: diff --git a/pages/kubernetes/reference-content/kubernetes-load-balancer.mdx b/pages/kubernetes/reference-content/kubernetes-load-balancer.mdx index b5fb7c94c3..09e6a90a30 100644 --- a/pages/kubernetes/reference-content/kubernetes-load-balancer.mdx +++ b/pages/kubernetes/reference-content/kubernetes-load-balancer.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Creating a [Load Balancer](/kubernetes/concepts/#load-balancer) for your Kubernetes cluster allows you to expose an application running inside your cluster to the internet. @@ -50,7 +52,7 @@ Here is a quick overview of how to create a Load Balancer for your cluster: ## Creating a Load Balancer for your cluster: Step by step - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/reference-content/lb-ingress-controller.mdx b/pages/kubernetes/reference-content/lb-ingress-controller.mdx index 8d56879b17..35c5e7e1db 100644 --- a/pages/kubernetes/reference-content/lb-ingress-controller.mdx +++ b/pages/kubernetes/reference-content/lb-ingress-controller.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-17 posted: 2025-06-17 --- +import Requirements from '@macros/iam/requirements.mdx' + This page walks you through the process of deploying an NGINX ingress controller on Scaleway's Kubernetes Kapsule service. We will configure a Load Balancer that uses a persistent IP address, which is essential for maintaining consistent routing. Additionally, we will enable the PROXY protocol to preserve client information such as the original IP address and port, which is recommended for applications that need to log or act on this data. @@ -21,7 +23,7 @@ We will explore the differences between ephemeral and persistent IP addresses, h By the end of this guide, you should have a robust and well-configured NGINX ingress controller running on Scaleway's Kubernetes platform. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/reference-content/managed-kubernetes-service-definition.mdx b/pages/kubernetes/reference-content/managed-kubernetes-service-definition.mdx index 117cbb05ce..839cc78437 100644 --- a/pages/kubernetes/reference-content/managed-kubernetes-service-definition.mdx +++ b/pages/kubernetes/reference-content/managed-kubernetes-service-definition.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import image from './assets/scaleway-managed-kubernetes-schema.webp' + Scaleway Kapsule and Kosmos are managed Kubernetes services. Scaleway's managed Kubernetes service abstracts away the complexities of managing and operating a Kubernetes cluster, enabling developers to focus on application development and deployment while ensuring a reliable and scalable environment for running containerized workloads. @@ -31,7 +33,7 @@ Scaleway offers support for the latest minor releases and patches, allowing the Furthermore, Scaleway provides information and reminders when older versions reach their end of support, ensuring that users stay informed and upgrade their clusters regularly. - + Scaleway is committed to providing updates on the product lifecycle as follows: diff --git a/pages/kubernetes/reference-content/managing-load-balancer-ips.mdx b/pages/kubernetes/reference-content/managing-load-balancer-ips.mdx index 68f8c56c2a..ba15dd859b 100644 --- a/pages/kubernetes/reference-content/managing-load-balancer-ips.mdx +++ b/pages/kubernetes/reference-content/managing-load-balancer-ips.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + By default, when you create a [Load Balancer](/kubernetes/concepts/#load-balancer) for your cluster, it will be assigned a random public IP address. When you delete the Load Balancer, the IP address will also be deleted and cannot be retrieved to transfer to another Load Balancer service in your cluster. @@ -25,7 +27,7 @@ Load Balancer flexible IPs have the following limitations: - They are scoped to a single Availability Zone. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/reference-content/migrate-end-of-life-pools-to-newer-instances.mdx b/pages/kubernetes/reference-content/migrate-end-of-life-pools-to-newer-instances.mdx index a8e90870b6..76012c672a 100644 --- a/pages/kubernetes/reference-content/migrate-end-of-life-pools-to-newer-instances.mdx +++ b/pages/kubernetes/reference-content/migrate-end-of-life-pools-to-newer-instances.mdx @@ -12,11 +12,13 @@ dates: categories: - containers --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway is deprecating support for certain Instance types that have reached their End of Life (EOL). This guide outlines the recommended steps to migrate your Kubernetes Kapsule cluster node pools from deprecated Instance types to currently supported ones. - + * A Scaleway account logged into the [Scaleway console](https://console.scaleway.com) * [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing actions in the intended Organization diff --git a/pages/kubernetes/reference-content/multi-az-clusters.mdx b/pages/kubernetes/reference-content/multi-az-clusters.mdx index ce4089e0ef..4407bed320 100644 --- a/pages/kubernetes/reference-content/multi-az-clusters.mdx +++ b/pages/kubernetes/reference-content/multi-az-clusters.mdx @@ -12,10 +12,14 @@ dates: categories: - kubernetes --- +import image from './assets/scaleway-k8s-multi-az-cluster.webp' +import image2 from './assets/scaleway-k8s-multi-az-2.webp' +import image3 from './assets/scaleway-k8s-multi-az-3.webp' + Kubernetes Kapsule clusters can use [Private Networks](/vpc/faq/#what-are-private-networks), providing a default security layer for worker nodes. Furthermore, these clusters can deploy node pools across various [Availability Zones (AZs)](/kubernetes/concepts/#multi-az-clusters). - + ## Advantages of using multiple Availability Zones @@ -202,7 +206,7 @@ spec: This service definition creates a load balancer in the "fr-par-1" zone and directs traffic to pods with the `resilient-app` label. Learn more about LoadBalancer annotations with our [dedicated Scaleway LoadBalancer Annotations](https://github.com/scaleway/scaleway-cloud-controller-manager/blob/master/docs/loadbalancer-annotations.md) documentation. * Cluster spread over three Availability Zones - + ### DNS with Dynamic Record (Health Check) @@ -211,7 +215,7 @@ Create a DNS record to direct traffic to active load balancers, assuming you hav The configuration uses `http_service` to verify the `ingress-nginx` service's status through the load balancers in both AZs, utilizing the "EXTERNAL-IP" from the Kubernetes services. The "ingress" DNS record in your `scw.your-domain.tld` domain will point to all healthy load balancer IPs using the "all" strategy. If an AZ fails, the DNS record will auto-update to point only to the healthy load balancer's IP, rerouting traffic to the remaining functional AZs. * Cluster with an unresponsive Availability Zone - + ```yaml data "scaleway_domain_zone" "multi-az" { diff --git a/pages/kubernetes/reference-content/secure-cluster-with-private-network.mdx b/pages/kubernetes/reference-content/secure-cluster-with-private-network.mdx index aa677c97f9..bb9d2109fa 100644 --- a/pages/kubernetes/reference-content/secure-cluster-with-private-network.mdx +++ b/pages/kubernetes/reference-content/secure-cluster-with-private-network.mdx @@ -12,12 +12,14 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Kubernetes Kapsule provides a managed environment to create, configure, and run a cluster of preconfigured machines for containerized applications. This allows you to create Kubernetes clusters without the complexity of managing the infrastructure. All new Kubernetes clusters are deployed with a Scaleway [Private Network](/vpc/concepts/#private-networks) using [controlled isolation](#what-is-the-difference-between-controlled-isolation-and-full-isolation). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/reference-content/wildcard-dns.mdx b/pages/kubernetes/reference-content/wildcard-dns.mdx index d562e71ddc..5df13ac0de 100644 --- a/pages/kubernetes/reference-content/wildcard-dns.mdx +++ b/pages/kubernetes/reference-content/wildcard-dns.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes wildcard DNS refers to a DNS configuration that allows for routing any subdomain of a domain to a particular service or set of services within a Kubernetes cluster. A wildcard DNS record is usually indicated by an asterisk (*), for example: `*.yourdomain.com`. @@ -23,7 +25,7 @@ Using wildcard DNS with Kubernetes has several advantages: In short, Kubernetes wildcard DNS, combined with an ingress controller, provides a powerful way to dynamically route external traffic to different services in the cluster based on hostname patterns. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/troubleshooting/configuring-sql-storage-backend-helm.mdx b/pages/kubernetes/troubleshooting/configuring-sql-storage-backend-helm.mdx index 7196b32b01..ffb5e4f610 100644 --- a/pages/kubernetes/troubleshooting/configuring-sql-storage-backend-helm.mdx +++ b/pages/kubernetes/troubleshooting/configuring-sql-storage-backend-helm.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + When deploying large Helm releases on Scaleway Kapsule Kubernetes, you might encounter errors like the following: @@ -23,7 +25,7 @@ This happens because Helm stores release information in Kubernetes **Secrets** o To resolve this issue, you can configure Helm to use an SQL storage backend such as **PostgreSQL**, bypassing the etcd size limitations and enabling larger Helm releases. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/kubernetes/troubleshooting/index.mdx b/pages/kubernetes/troubleshooting/index.mdx index 3ef0fc21fb..804b210cd7 100644 --- a/pages/kubernetes/troubleshooting/index.mdx +++ b/pages/kubernetes/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: KubernetesProductIcon ## Featured Pages - - - - - - + - A Scaleway [account](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/load-balancer/api-cli/setting-up-ssl-offloading.mdx b/pages/load-balancer/api-cli/setting-up-ssl-offloading.mdx index 6f0bb93ee3..29915104e8 100644 --- a/pages/load-balancer/api-cli/setting-up-ssl-offloading.mdx +++ b/pages/load-balancer/api-cli/setting-up-ssl-offloading.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + SSL offloading describes a pattern where the Load Balancer terminates encrypted connections at the frontend (decrypting incoming traffic), to forward it unencrypted to the backend servers. This effectively “offloads” the work of decrypting traffic from the backend server to the Load Balancer. @@ -19,7 +21,7 @@ You can read more about SSL offloading, compared to SSL bridging or passthrough, This page shows you how to create a Load Balancer configured for SSL offloading using the [Load Balancer API](https://www.scaleway.com/en/developers/api/load-balancer/zoned-api/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/load-balancer/concepts.mdx b/pages/load-balancer/concepts.mdx index f3d44be28d..dbd7a507db 100644 --- a/pages/load-balancer/concepts.mdx +++ b/pages/load-balancer/concepts.mdx @@ -11,10 +11,13 @@ dates: categories: - networks --- +import EdgeServicesLbBenefits from '@macros/edge-services/edge-services-lb-benefits.mdx' +import Acls from '@macros/network/acls.mdx' + ## ACL - + Learn how to use the ACL feature in our [dedicated how-to](/load-balancer/how-to/create-manage-acls/) and go deeper with our [reference documentation](/load-balancer/reference-content/acls/) @@ -83,7 +86,7 @@ Benefits of using this feature include: Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. - + ## First available diff --git a/pages/load-balancer/how-to/add-certificate.mdx b/pages/load-balancer/how-to/add-certificate.mdx index ef234debc1..0a5c19b2c5 100644 --- a/pages/load-balancer/how-to/add-certificate.mdx +++ b/pages/load-balancer/how-to/add-certificate.mdx @@ -9,6 +9,14 @@ dates: validation: 2025-05-27 posted: 2022-10-20 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-cert-lets-encrypt.webp' +import image2 from './assets/scaleway-edit-frontend.webp' +import image3 from './assets/scaleway-certificate-import.webp' +import image4 from './assets/scaleway-create-self-certificate.webp' +import image5 from './assets/scaleway-edit-frontend.webp' + ## Introduction to SSL/TLS certificates @@ -56,7 +64,7 @@ Note that after creating your certificate, you **must** [add it to a specified f ## How to generate and add a Let's Encrypt certificate - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -77,7 +85,7 @@ Bear in mind the following restrictions for creating Let's Encrypt certificates: 4. Click **Create SSL certificate**. A pop-up displays: - + 5. Enter the required information: @@ -94,7 +102,7 @@ Bear in mind the following restrictions for creating Let's Encrypt certificates: 8. Click the three dot menu next to the frontend you want to add the certificate to, then click **Edit**. - + 9. Select the certificate you just created from the **SSL Certificate(s)** drop-down, then click **Edit Frontend**. @@ -102,7 +110,7 @@ Your certificate is added to your Load Balancer's frontend. ## How to import a certificate - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -123,7 +131,7 @@ Alternatively you can also choose to import a **[self-signed certificate](#how-t 4. Click **Create an SSL certificate**. A pop-up displays: - + 5. Enter the required information: @@ -135,13 +143,13 @@ Alternatively you can also choose to import a **[self-signed certificate](#how-t You are returned to the **SSL certificates** tab where your newly-created certificate now appears. You must now attach the certificate to your frontend: - + 7. Click **Frontends**. 8. Click the three dot menu next to the frontend you want to add the certificate to, then click **Edit** - + 9. Select the certificate you just created from the **SSL Certificate(s)** drop-down, then click **Edit Frontend**. diff --git a/pages/load-balancer/how-to/create-frontends-backends.mdx b/pages/load-balancer/how-to/create-frontends-backends.mdx index cf63faf1fb..0da6f0bd26 100644 --- a/pages/load-balancer/how-to/create-frontends-backends.mdx +++ b/pages/load-balancer/how-to/create-frontends-backends.mdx @@ -12,10 +12,19 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import LbCreateBackend1Basic from '@macros/network/lb-create-backend-1-basic.mdx' +import LbCreateBackend2TrafficMgnt from '@macros/network/lb-create-backend-2-traffic-mgnt.mdx' +import LbCreateBackend3AdvancedSettings from '@macros/network/lb-create-backend-3-advanced-settings.mdx' +import LbCreateBackend4Healthcheck from '@macros/network/lb-create-backend-4-healthcheck.mdx' + +import image from './assets/scaleway-configure-frontend.webp' +import image2 from './assets/scaleway-create-frontend-after.webp' + When you create a Load Balancer, you can either add frontends and backends during the initial creation process, or you can create your Load Balancer without any frontends or backends and add them later. This page explains how to create and configure frontends and backends for your Load Balancer at any stage. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -24,7 +33,7 @@ When you create a Load Balancer, you can either add frontends and backends durin 1. Follow the steps for [creating a Load Balancer](/load-balancer/how-to/create-load-balancer/). At the last stage, click **Add frontend and backend**. The following screen displays, the first step inviting you to configure a frontend: - + 2. Enter a **name** for your frontend. @@ -42,25 +51,25 @@ Follow the steps for [creating a Load Balancer and creating a frontend](#how-to- ### Configuring basic settings - + Continue to the next section for configuring traffic management. ### Configuring traffic management - + Continue to the next section for configuring advanced settings. ### Configuring advanced settings - + Continue to the next section for configuring health checks. ### Configuring health checks - + ### Confirming creation of your frontend and backend @@ -79,7 +88,7 @@ You can add one or many frontends to your Load Balancer after its creation. Foll 4. Click the **+ Add frontend** button. The frontend creation wizard displays. - + 5. Enter a **name**, **port** and (if necessary) [**SSL certificate(s)**](/load-balancer/how-to/add-certificate/) for your new frontend. Note that each frontend must listen on a different port. diff --git a/pages/load-balancer/how-to/create-load-balancer.mdx b/pages/load-balancer/how-to/create-load-balancer.mdx index 0042c297ad..8824ea98f6 100644 --- a/pages/load-balancer/how-to/create-load-balancer.mdx +++ b/pages/load-balancer/how-to/create-load-balancer.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + [Load Balancers](https://www.scaleway.com/en/load-balancer/) are highly available and fully-managed Instances which allow you to distribute your workload across your various servers. They ensure the scaling of all your applications while securing their continuous availability, even in the event of heavy traffic. Load Balancers are commonly used to improve the performance and reliability of websites, applications, databases, and other services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/load-balancer/how-to/create-manage-acls.mdx b/pages/load-balancer/how-to/create-manage-acls.mdx index dc0125ab7a..34643c8589 100644 --- a/pages/load-balancer/how-to/create-manage-acls.mdx +++ b/pages/load-balancer/how-to/create-manage-acls.mdx @@ -12,14 +12,22 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import Acls from '@macros/network/acls.mdx' - +import image from './assets/scaleway-acl-splash.webp' +import image2 from './assets/scaleway-create-acl.webp' +import image3 from './assets/scaleway-acl-condition.webp' +import image4 from './assets/scaleway-acl-conditions-filters.webp' + + + This page shows you how to create and manage ACLs. For more details on how ACLs work, and specification configuration examples, see our [ACL reference page](/load-balancer/reference-content/acls/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -41,11 +49,11 @@ ACLs are created and managed at the frontend(s) of your Load Balancer. 5. Click the **ACLs** tab. - + 6. Click **Create ACL** or the button. The ACL creation wizard displays. - + The first part of the wizard asks you to set a name and optional description for the ACL. @@ -73,7 +81,7 @@ ACLs are created and managed at the frontend(s) of your Load Balancer. - If you do not enable a condition, the action will be applied uniformly to all traffic arriving at the Load Balancer's frontend. - If you enable a condition, the action will be applied only to traffic meeting the condition you set below. - + 10. Set the condition type for your action, if you enabled a condition in the previous step. Choose from: - **IF MATCH**: The action will be applied to all traffic that matches the filters (defined in the next step). @@ -90,7 +98,7 @@ ACLs are created and managed at the frontend(s) of your Load Balancer. For more information about setting up conditions and filters for ACLs, see our [reference documentation](/load-balancer/reference-content/acls/#what-conditions-can-be-set-for-acls) - + 12. Click **Create ACL** to finish. Your ACL is created, and you are redirected to the ACLs tab, where your new ACL now appears. diff --git a/pages/load-balancer/how-to/create-manage-flex-ips.mdx b/pages/load-balancer/how-to/create-manage-flex-ips.mdx index 14e18242d5..a5ed9bc004 100644 --- a/pages/load-balancer/how-to/create-manage-flex-ips.mdx +++ b/pages/load-balancer/how-to/create-manage-flex-ips.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to use [Load Balancer flexible IP addresses](/load-balancer/concepts/#flexible-ip-address). A flexible IP address is a public IP address for your Load Balancer. @@ -27,7 +29,7 @@ The following limitations apply to Load Balancer flexible IPs: - Flexible IPs are associated with a particular product and cannot be moved to a different type of resource. For example, a flexible IP for Load Balancer can be used with another Load Balancer in the same AZ, but it cannot be used with other resource types like Instances or Elastic Metal servers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/load-balancer/how-to/create-manage-routes.mdx b/pages/load-balancer/how-to/create-manage-routes.mdx index 5e6f044321..a572bf0880 100644 --- a/pages/load-balancer/how-to/create-manage-routes.mdx +++ b/pages/load-balancer/how-to/create-manage-routes.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + Routes allow you to specify, for a given frontend, which backends it should direct traffic to depending on the requested host. For [HTTP](/load-balancer/concepts/#protocol) frontends/backends, routes are based on HTTP Host headers. For [TCP](/load-balancer/concepts/#protocol) frontends/backends, they are based on **S**erver **N**ame **I**dentification (SNI). You can configure multiple routes on a single frontend. When no route rules match for an incoming connection/request, the frontend will forward to its default backend. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/load-balancer/how-to/delete-load-balancer.mdx b/pages/load-balancer/how-to/delete-load-balancer.mdx index 2ecc0a171c..c737a07dff 100644 --- a/pages/load-balancer/how-to/delete-load-balancer.mdx +++ b/pages/load-balancer/how-to/delete-load-balancer.mdx @@ -12,8 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-confirm-deletion.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -35,6 +39,6 @@ categories: 6. Click **Delete Load Balancer**. - + diff --git a/pages/load-balancer/how-to/manage-frontends-and-backends.mdx b/pages/load-balancer/how-to/manage-frontends-and-backends.mdx index f9422e161e..10f9f3ab1e 100644 --- a/pages/load-balancer/how-to/manage-frontends-and-backends.mdx +++ b/pages/load-balancer/how-to/manage-frontends-and-backends.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edit-backends.webp' + Once you have created a frontend and a backend for your Load Balancer, you can: - Add additional frontends and backends @@ -20,7 +24,7 @@ Once you have created a frontend and a backend for your Load Balancer, you can: This page shows you how to carry out these actions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -68,7 +72,7 @@ See our [dedicated documentation](/load-balancer/how-to/create-frontends-backend 5. Click **Edit backend** or **Edit health check**. 6. Make your edits. - + 7. Click **Edit backend** (or **Edit health check**) once your edits are done. diff --git a/pages/load-balancer/how-to/monitor-lb-cockpit.mdx b/pages/load-balancer/how-to/monitor-lb-cockpit.mdx index 38f45feef6..ce72e06b48 100644 --- a/pages/load-balancer/how-to/monitor-lb-cockpit.mdx +++ b/pages/load-balancer/how-to/monitor-lb-cockpit.mdx @@ -12,10 +12,23 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-lb-dashboard.webp' +import image2 from './assets/scaleway-loadbalancer-params.webp' +import image3 from './assets/scaleway-loadbalancer-status.webp' +import image4 from './assets/scaleway-lb-throughputs.webp' +import image5 from './assets/scaleway-lb-active-connections.webp' +import image6 from './assets/scaleway-lb-layer7.webp' +import image7 from './assets/scaleway-logs-cockpit-overview.webp' +import image8 from './assets/scaleway-backend-server-down.webp' +import image9 from './assets/scaleway-backend-down.webp' +import image10 from './assets/scaleway-backend-server-up.webp' + You can view your Load Balancer's metrics and logs by using [Scaleway Cockpit](/cockpit/quickstart/). Load Balancer is fully integrated into Cockpit, and allows you to monitor your Load Balancers frontends, backends, and backend servers at a glance, and visualize your metrics, traffic and logs. This page explains how to get started with Scaleway Cockpit for viewing your Load Balancers metrics and logs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -41,13 +54,13 @@ From the Scaleway Cockpit dashboards homepage, click **Dashboards** in the side You are directed to the Load Balancer Overview dashboard. - + ### Choosing metric parameters At the top of the dashboard, you can configure the following parameters, which control which metrics are displayed: - + - **A: Time period**: Click this drop-down to configure the time period you want the metrics displayed to cover. You can set an absolute time range, from one fixed date-time to another, or use a quick range such as `Last 15 minutes` or `Last 3 hours`. - **B: Refresh rate**: Use the arrow icon to refresh the dashboard, and/or use the drop-down next to it to set the automatic refresh rate. @@ -59,7 +72,7 @@ At the top of the dashboard, you can configure the following parameters, which c In this section, you see various graphs which report on the status of different components of your Load Balancer. - + - **Healthy loadbalancer backends**: Shows how many of your Load Balancer's backends currently have a healthy status. A backend is considered healthy if at least one of its [backend servers](/load-balancer/concepts/#backend-servers) is healthy and up. - **Healthy loadbalancer backend servers**: Shows how many of your Load Balancer's backend servers are currently in a healthy state. A backend server is considered healthy if it passes its [health checks](/load-balancer/concepts/#health-checks), specifically if the number of failed health checks does not exceed the value set in the `Unhealthy threshold` parameter. @@ -70,7 +83,7 @@ In this section, you see various graphs which report on the status of different In this section, you see various graphs detailing the delivered and received throughput for your Load Balancer. That is to say, you see the amount of data passing through its frontends, backends, and backend servers. - + In these graphs, negative numbers represent sent/outgoing data, while positive numbers represent received/incoming data. @@ -88,7 +101,7 @@ In this section, you see various graphs detailing the current number of active c This section concerns connections over TCP protocol. However, in the case of a Load Balancer configured to use HTTP protocol, its data will still be reported here (as well as the Layer 7 section below) as the HTTP/HTTPS protocols are included within TCP protocol. - + - For each frontend, backend and backend server, you can view: - The number of current open connections. @@ -99,7 +112,7 @@ This section concerns connections over TCP protocol. However, in the case of a L In this section, you see various graphs detailing the layer 7 (application layer) actions of your Load Balancer. - + - For each frontend, backend and backend server, you can view: - The HTTP request rate @@ -111,7 +124,7 @@ From the Scaleway Cockpit dashboards homepage, click **Dashboards** in the side You are directed to the Load Balancer Logs Overview dashboard. - + ### Choosing log parameters @@ -125,19 +138,19 @@ The following events are logged: Logs when a backend server becomes inaccessible. - + #### Backend down Logs when all the backend servers of a backend become inaccessible. - + #### Backend server up Logs when a backend server that was previously inaccessible becomes accessible again. - + #### Certificate expired diff --git a/pages/load-balancer/how-to/resize-lb.mdx b/pages/load-balancer/how-to/resize-lb.mdx index 0094558435..6d2174b91e 100644 --- a/pages/load-balancer/how-to/resize-lb.mdx +++ b/pages/load-balancer/how-to/resize-lb.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-resize-lb.webp' + You can resize an existing Scaleway Load Balancer if you want to switch to a different [offer type](https://www.scaleway.com/en/pricing/network/#load-balancer). This will allow you to access higher bandwidth, better performance and potentially multi-cloud backend servers. Resizing a Load Balancer can be done via the Scaleway console by following the steps below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -27,7 +31,7 @@ You can resize an existing Scaleway Load Balancer if you want to switch to a dif 3. Scroll down to the **Resize** panel, and click **Resize**. A pop-up displays: - + 4. Choose the Load Balancer type that you want to resize to. For full details of available types, their features and the cost, see our [pricing page](https://www.scaleway.com/en/pricing/network/#load-balancer). diff --git a/pages/load-balancer/how-to/set-up-s3-failover.mdx b/pages/load-balancer/how-to/set-up-s3-failover.mdx index 504e1d4606..63c9e9aab0 100644 --- a/pages/load-balancer/how-to/set-up-s3-failover.mdx +++ b/pages/load-balancer/how-to/set-up-s3-failover.mdx @@ -12,6 +12,11 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-customized-error-page.webp' +import image2 from './assets/scaleway-customized-error-page.webp' + The **customized error page** feature allows you to redirect users to a static website hosted on Scaleway Object Storage, in the case that none of your Load Balancer's backends are available to serve the requested content. This website could be a simple, single webpage or else something much more complex: you build it according to your own requirements. @@ -25,7 +30,7 @@ Benefits of using this feature include: You can set up a customized error page during creation of your Load Balancer, or at any point after creation. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -35,7 +40,7 @@ You can set up a customized error page during creation of your Load Balancer, or 1. Follow the instructions for [creating a Load Balancer](/load-balancer/how-to/create-load-balancer/). 2. Click the **+Advanced Settings** button while configuring your backend. - + 3. Slide the toggle to activate the customized error page feature, and enter a Scaleway Object Storage [Bucket Website](/object-storage/concepts/#bucket-website) URL in the box. Note that the URL of the bucket endpoint is not sufficient, the bucket website URL is specifically required (e.g.`https://my-bucket.s3-website.nl-ams.scw.cloud`). This feature is only available for Load Balancers using the HTTP protocol on their backend. @@ -49,7 +54,7 @@ You can set up a customized error page during creation of your Load Balancer, or 3. Click the **Backends** tab. The list of your backends displays. 4. Click the backend you wish to configure a customized error page for, and click the **Edit** button. 5. Click the **+ Advanced Settings** button. - + 6. Slide the toggle to activate or deactivate the customized error page feature as required. This feature is only available for Load Balancers using the HTTP protocol on their backend. diff --git a/pages/load-balancer/how-to/use-edge-services.mdx b/pages/load-balancer/how-to/use-edge-services.mdx index e3df725c8e..9c0c43f1e2 100644 --- a/pages/load-balancer/how-to/use-edge-services.mdx +++ b/pages/load-balancer/how-to/use-edge-services.mdx @@ -12,14 +12,19 @@ tags: load-balancer edge-services cdn network cache domain https categories: - network --- +import EdgeServicesLbBenefits from '@macros/edge-services/edge-services-lb-benefits.mdx' +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-create-es-pipeline-lb.webp' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. - + Read on to learn how to create an Edge Services pipeline for your Load Balancer origin. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -43,7 +48,7 @@ You can create an Edge Services pipeline from the **Edge Services** section of t 3. Click **Create Edge Services pipeline**. The pipeline creation wizard displays. - + 4. [Follow step 3 onwards](/edge-services/how-to/create-pipeline-lb/#how-to-create-an-edge-services-pipeline-for-load-balancer) in our dedicated Edge Services documentation to finish creating your pipeline. diff --git a/pages/load-balancer/how-to/use-with-private-network.mdx b/pages/load-balancer/how-to/use-with-private-network.mdx index 9e6b9fb068..21e43aeaa2 100644 --- a/pages/load-balancer/how-to/use-with-private-network.mdx +++ b/pages/load-balancer/how-to/use-with-private-network.mdx @@ -12,12 +12,17 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-lb-pn-attach.webp' +import image2 from './assets/scaleway-load-balancer-detach-private-network.webp' + The Private Network feature of the managed Load Balancers product lets you attach your Load Balancer to up to eight different Private Networks. [Scaleway Private Networks](/vpc/concepts/#private-networks) allow your cloud resources to communicate in an isolated and secure network. Load Balancers using Private Networks can communicate with their backend servers without using the public internet. [Private Load Balancers](/load-balancer/concepts/#private-load-balancer) must be connected to a Private Network in order to be functional, as they do not have a public IP address and can only receive requests from other resources in the same VPC. This is in contrast to public Load Balancers, which are accessible for requests via the internet through their public IP address, but can optionally use Private Networks to communicate with their backend servers. The procedure for attaching either a public or a private Load Balancer to a Private Network is the same, and described below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +36,7 @@ The Private Network feature of the managed Load Balancers product lets you attac 3. Click the **Private Networks** tab. 4. Click **Attach to a Private Network**. A pop-up displays. - + 5. Select whether to attach to a new Private Network, or an existing one. 6. Choose whether to **auto-allocate an available IP from the pool** (the [CIDR block](/vpc/concepts/#cidr-block) defined at the time of creating the Private Network), or use a **[reserved IP address](/ipam/concepts/#reserved-ip-address)** for the attachment. @@ -45,7 +50,7 @@ The Private Network feature of the managed Load Balancers product lets you attac 2. Click on the Load Balancer that you want to detach from a Private Network. 3. Click the **Private Networks** tab. The list of Private Networks attached to your Load Balancer displays. 4. Click the button next to the Private Network that you want to detach from the Load Balancer, then click **Detach resource** when prompted. - + The Private Network is detached from the Load Balancer, and disappears from the **Private Network** tab. diff --git a/pages/load-balancer/index.mdx b/pages/load-balancer/index.mdx index 69418dd837..d799537f09 100644 --- a/pages/load-balancer/index.mdx +++ b/pages/load-balancer/index.mdx @@ -4,7 +4,7 @@ meta: description: Dive into Scaleway Load Balancers with our quickstart guides, how-tos, tutorials, and more. --- - - - - - \ No newline at end of file +/> diff --git a/pages/load-balancer/quickstart.mdx b/pages/load-balancer/quickstart.mdx index 8abf1e625c..c98e4ceb3f 100644 --- a/pages/load-balancer/quickstart.mdx +++ b/pages/load-balancer/quickstart.mdx @@ -12,10 +12,18 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import LbCreateBackend1Basic from '@macros/network/lb-create-backend-1-basic.mdx' +import LbCreateBackend2TrafficMgnt from '@macros/network/lb-create-backend-2-traffic-mgnt.mdx' +import LbCreateBackend3AdvancedSettings from '@macros/network/lb-create-backend-3-advanced-settings.mdx' +import LbCreateBackend4Healthcheck from '@macros/network/lb-create-backend-4-healthcheck.mdx' + +import image from './assets/scaleway-configure-frontend.webp' + [Load Balancers](https://www.scaleway.com/en/load-balancer/) are highly available and fully-managed Instances which allow you to distribute your workload across your various servers. They ensure the scaling of all your applications while securing their continuous availability, even in the event of heavy traffic. Load Balancers are commonly used to improve the performance and reliability of websites, applications, databases and other services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -44,7 +52,7 @@ categories: ## How to configure your frontend - + 1. Enter a **name** for your frontend. @@ -60,25 +68,25 @@ Continue to the next section for [creating a backend](#how-to-configure-your-bac ### Configuring basic settings - + Continue to the next section for configuring traffic management. ### Configuring traffic management - + Continue to the next section for configuring advanced settings. ### Configuring advanced settings - + Continue to the next section for configuring health checks. ### Configuring health checks - + ### Confirming creation of your frontend and backend diff --git a/pages/load-balancer/reference-content/acls.mdx b/pages/load-balancer/reference-content/acls.mdx index 512ccd5be2..add44f8dad 100644 --- a/pages/load-balancer/reference-content/acls.mdx +++ b/pages/load-balancer/reference-content/acls.mdx @@ -12,10 +12,15 @@ categories: - load-balancer - network --- +import Acls from '@macros/network/acls.mdx' + +import image from './assets/scaleway-acl-list.webp' +import image2 from './assets/scaleway-acl-condition.webp' + ## What is an Access Control List (ACL)? - + You can learn how to set up ACLs in our [how to documentation](/load-balancer/how-to/create-manage-acls/). This page gives more detailed information, and advice about achieving specific configurations with your ACLs. @@ -23,7 +28,7 @@ You can learn how to set up ACLs in our [how to documentation](/load-balancer/ho ACLs are created and managed on the **frontend** of a Load Balancer. You can create a **list** of ACLs on each frontend. - + Each ACL in the list has a number to show its **priority**. All traffic arriving at this frontend will be filtered through the list of ACLs. The ACL with priority number 1, goes first, followed by number 2 etc, until the end of the list. @@ -44,7 +49,7 @@ Condition types are: - **IF NO MATCH**: The ACL applies its action to all traffic that does **not** match the given filters. - + Filter types are: - **IP filter**: This filter type is available for all frontends. You can filter for one or many source IPv4 or IPv6 addresses, or IP blocks. diff --git a/pages/load-balancer/reference-content/http2-http3.mdx b/pages/load-balancer/reference-content/http2-http3.mdx index af19d5f4e2..965f07e3c4 100644 --- a/pages/load-balancer/reference-content/http2-http3.mdx +++ b/pages/load-balancer/reference-content/http2-http3.mdx @@ -12,6 +12,9 @@ categories: - load-balancer - network --- +import image from './assets/scaleway-http-2-3.webp' +import image2 from './assets/scaleway-enable-http3.webp' + ## HTTP overview @@ -49,7 +52,7 @@ In brief: - Scaleway Load Balancers support HTTP/2 connections to frontends with TLS, and HTTP/2 connections from backends with TLS to backend servers. - Scaleway Load Balancers support HTTP/3 connections to frontends with TLS, but do not support HTTP/3 connections from backends to backend servers. - + ## Configuring your Load Balancer for HTTP/2 @@ -83,4 +86,4 @@ To create a frontend that allows HTTP/3 connections, follow the instructions for - Under **Configure backend**, ensure that you choose a backend using HTTP protocol. - Under **Advanced Settings**, select **Enable HTTP/3**. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/load-balancer/reference-content/public-private-accessibility.mdx b/pages/load-balancer/reference-content/public-private-accessibility.mdx index 60d36ffa3a..f208dd051d 100644 --- a/pages/load-balancer/reference-content/public-private-accessibility.mdx +++ b/pages/load-balancer/reference-content/public-private-accessibility.mdx @@ -12,6 +12,10 @@ dates: validation: 2025-06-23 posted: 2024-06-14 --- +import image from './assets/scaleway-public-lb.webp' +import image2 from './assets/scaleway-private-lb.webp' +import image3 from './assets/scaleway-privatelb-multipn.webp' + When creating a Load Balancer, you are prompted to configure its accessibility. There are two options: **private** or **public**. @@ -33,7 +37,7 @@ A Load Balancer is defined as public when you choose the "public" accessibility - It can be configured or deleted using the Scaleway API, console, CLI, Terraform/OpenTofu or other developer tools. - It provides its metrics to [Scaleway Cockpit](/cockpit/concepts/#cockpit), allows the use of Let's Encrypt certificates, and (if the appropriate Load Balancer type is selected), supports multi-cloud IP addresses for its backend servers. - + ## Private Load Balancers @@ -49,8 +53,8 @@ A Load Balancer is defined as private when you choose the "private" accessibilit A private Load Balancer can be used to balance requests between backends internally, where your backends' clients are in the same VPC as the Load Balancer. The security of your infrastructure is strengthened, as the Load Balancer does not have a public IP address and is not accessible over the public internet. - + When you attach a private Load Balancer to multiple Private Networks, it has an IP address in each one. The Load Balancer can then forward traffic to any resource or service attached to any of its Private Networks, thus allowing inter-Private-Networks load balancing. Scaleway's managed DNS also makes it possible to contact the Load Balancer over the Private Network without knowing its IP address (using `lb-name.pn-name.internal`, which then resolves to its private IP address). [VPC routing](/vpc/concepts/#routing) also allows Load Balancers on different Private Networks in the same VPC to communicate. - \ No newline at end of file + \ No newline at end of file diff --git a/pages/load-balancer/reference-content/sni-route-deprecation.mdx b/pages/load-balancer/reference-content/sni-route-deprecation.mdx index b464fba43f..8f920b59c8 100644 --- a/pages/load-balancer/reference-content/sni-route-deprecation.mdx +++ b/pages/load-balancer/reference-content/sni-route-deprecation.mdx @@ -13,6 +13,9 @@ categories: - load-balancer - network --- +import image from './assets/scaleway-sni-route.webp' +import image2 from './assets/scaleway-http-route.webp' + This page documents the deprecation of SNI routes with HTTP backends on Scaleway Load Balancers @@ -38,11 +41,11 @@ See the console screenshots below as examples: **Backend lbb-hungry-napier uses TCP protocol, and supports SNI routes**: - + **Backend lbb-king-volhard uses HTTP protocol, and supports HTTP Host header routes**: - + ## What was the impact? diff --git a/pages/load-balancer/reference-content/ssl-bridging-offloading-passthrough.mdx b/pages/load-balancer/reference-content/ssl-bridging-offloading-passthrough.mdx index 95841904fc..1b45de4b1c 100644 --- a/pages/load-balancer/reference-content/ssl-bridging-offloading-passthrough.mdx +++ b/pages/load-balancer/reference-content/ssl-bridging-offloading-passthrough.mdx @@ -12,6 +12,10 @@ categories: - load-balancer - network --- +import image from './assets/scaleway-ssl-bridging.webp' +import image2 from './assets/scaleway-ssl-offloading.webp' +import image3 from './assets/scaleway-ssl-passthrough.webp' + In this document, we explain some of the different configurations available when setting up your Load Balancer, in terms of how the Load Balancer should deal with encrypted traffic. The three main configurations are: @@ -25,7 +29,7 @@ Read on to find out how to configure your Scaleway Load Balancer for any of thes SSL bridging allows the user to initiate a secure, encrypted connection with the Load Balancer thanks to the Load Balancer frontend's SSL certificate. The Load Balancer decrypts incoming HTTPS traffic. This allows the Load Balancer to carry out layer 7 actions on the received traffic. The Load Balancer's backend then initiates a new encrypted connection to re-encrypt traffic between the Load Balancer and the backend server, this time using the backend server's certificate. - + To configure your Load Balancer for SSL bridging: @@ -37,7 +41,7 @@ To configure your Load Balancer for SSL bridging: SSL offloading, also known as SSL termination, allows the user to initiate a secure connection with the Load Balancer thanks to the Load Balancer frontend's SSL certificate. The Load Balancer decrypts incoming HTTPS traffic. Layer 7 actions may therefore be applied to the traffic at this stage. Traffic is not re-encrypted on its way from the Load Balancer to the backend server, unlike with SSL bridging. Traffic that has gone through the offloading process is marked with a new header, called `X-Forwarded-Proto`, which informs the backend server that the client used HTTPS to contact the Load Balancer. - + To configure your Load Balancer for SSL offloading: @@ -51,7 +55,7 @@ If you want to configure your Load Balancer for SSL offloading using the API, se Passthrough is the simplest way to handle encrypted traffic on a Load Balancer. As the name suggests, traffic is simply passed through the Load Balancer without being decrypted on it. Whilst this option generates very low overhead, no layer 7 actions can be carried out. This means that no cookie-based sticky sessions are possible with this method. In addition, if an application does not share sessions between servers, users’ sessions may get lost by being redirected to different servers of the group. - + To configure your Load Balancer for SSL passthrough: diff --git a/pages/load-balancer/troubleshooting/index.mdx b/pages/load-balancer/troubleshooting/index.mdx index 2e64d690c8..961853a34d 100644 --- a/pages/load-balancer/troubleshooting/index.mdx +++ b/pages/load-balancer/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: LbProductIcon ## Featured Pages - - - - - - + ## Boot-on-block - + ## Local volumes - + ## Power-off mode @@ -34,4 +39,4 @@ Standby mode is a way to stop an Instance temporarily. When you put an Instance ## Volumes - \ No newline at end of file + \ No newline at end of file diff --git a/pages/local-storage/how-to/attach-volume.mdx b/pages/local-storage/how-to/attach-volume.mdx index 804f9f028b..495a514809 100644 --- a/pages/local-storage/how-to/attach-volume.mdx +++ b/pages/local-storage/how-to/attach-volume.mdx @@ -13,10 +13,12 @@ categories: - block-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can attach a Local Storage volume to your Instance at any time, as long as they are both in the same [Availability Zone](/instances/concepts/#availability-zone). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/how-to/create-snapshot.mdx b/pages/local-storage/how-to/create-snapshot.mdx index 758cba987e..abeddeb97e 100644 --- a/pages/local-storage/how-to/create-snapshot.mdx +++ b/pages/local-storage/how-to/create-snapshot.mdx @@ -12,6 +12,10 @@ dates: categories: - storage --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-create-from-snapshot.webp' + The snapshot feature allows you to create an image of a specific Local Storage volume of your Instance. A snapshot is a full-volume copy stored in our secure data centers. They are usually used to recover volume data or to create a copy of a volume. @@ -20,7 +24,7 @@ The snapshot feature allows you to create an image of a specific Local Storage v * The snapshot feature creates backups of specific volumes only. If you wish to create a backup image that is a complete backup of your Instance including **all** of its volumes, check out our documentation on [how to create an image](/instances/how-to/create-a-backup/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -54,6 +58,6 @@ You can create a [volume](/instances/concepts/#volumes) from a snapshot as follo Follow the instructions for [creating an Instance](/instances/how-to/create-an-instance/). At the **Choose an image** step of the creation wizard, click the **My snapshots** tab, and select the desired snapshot. - + You can see the snapshotted volume in the Instance's volumes at **step 4** of the creation wizard. \ No newline at end of file diff --git a/pages/local-storage/how-to/create-volume-from-snapshot.mdx b/pages/local-storage/how-to/create-volume-from-snapshot.mdx index 6b3213a6a6..51a7cc44b3 100644 --- a/pages/local-storage/how-to/create-volume-from-snapshot.mdx +++ b/pages/local-storage/how-to/create-volume-from-snapshot.mdx @@ -13,8 +13,10 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/how-to/create-volume.mdx b/pages/local-storage/how-to/create-volume.mdx index fc4cac6d29..9ee9e253bb 100644 --- a/pages/local-storage/how-to/create-volume.mdx +++ b/pages/local-storage/how-to/create-volume.mdx @@ -13,8 +13,10 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/how-to/delete-snapshot.mdx b/pages/local-storage/how-to/delete-snapshot.mdx index 95966acb73..ab97669f19 100644 --- a/pages/local-storage/how-to/delete-snapshot.mdx +++ b/pages/local-storage/how-to/delete-snapshot.mdx @@ -13,8 +13,10 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/how-to/delete-volume.mdx b/pages/local-storage/how-to/delete-volume.mdx index 82979d1658..8d1f0aff59 100644 --- a/pages/local-storage/how-to/delete-volume.mdx +++ b/pages/local-storage/how-to/delete-volume.mdx @@ -13,8 +13,10 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/how-to/detach-volume.mdx b/pages/local-storage/how-to/detach-volume.mdx index 52f93335c4..0937f5f16a 100644 --- a/pages/local-storage/how-to/detach-volume.mdx +++ b/pages/local-storage/how-to/detach-volume.mdx @@ -13,10 +13,12 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can detach a Local Storage volume from your Instance when it is powered off. It is important to [unmount the volume](/block-storage/api-cli/unmounting-a-volume/) from the operating system before detaching it to avoid data loss. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/local-storage/quickstart.mdx b/pages/local-storage/quickstart.mdx index b683c68997..ab1c2697e7 100644 --- a/pages/local-storage/quickstart.mdx +++ b/pages/local-storage/quickstart.mdx @@ -13,6 +13,8 @@ categories: - local-storage - storage --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Local Storage is a storage solution integrated directly into some of Scaleway's cloud Instances. The storage capacity varies by Instance type, with a maximum of 600 GB. Local Storage is tied to the lifespan of the Instance; data stored locally will be lost if the Instance is terminated. @@ -22,7 +24,7 @@ For persistent storage needs, Scaleway offers [Block Storage](/block-storage/), Discover the Local Storage interface on the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/api-cli/connecting-managed-databases-to-kubernetes-clusters.mdx b/pages/managed-databases-for-postgresql-and-mysql/api-cli/connecting-managed-databases-to-kubernetes-clusters.mdx index 533a48e822..e015f5aad4 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/api-cli/connecting-managed-databases-to-kubernetes-clusters.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/api-cli/connecting-managed-databases-to-kubernetes-clusters.mdx @@ -10,12 +10,14 @@ dates: validation: 2025-03-26 posted: 2025-03-26 --- +import Requirements from '@macros/iam/requirements.mdx' + This guide explains how to set up and connect a Scaleway Managed Database for PostgreSQL or MySQL with a Scaleway Kubernetes Kapsule cluster. We will walk you through the entire process using both the Scaleway CLI and Terraform approaches. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/api-cli/import-data-to-managed-postgresql-databases.mdx b/pages/managed-databases-for-postgresql-and-mysql/api-cli/import-data-to-managed-postgresql-databases.mdx index b537ecd159..c3e2b38c49 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/api-cli/import-data-to-managed-postgresql-databases.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/api-cli/import-data-to-managed-postgresql-databases.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-01-02 posted: 2024-06-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Managed Databases for PostgreSQL offers near-complete PostgreSQL compatibility, and allows you to import or migrate your data from any PostgreSQL-compatible database. @@ -19,7 +21,7 @@ The methods listed below are best suited for database sizes below 100 GB (approx Refer to [this tutorial](/tutorials/migrate-databases-instance/) to migrate large databases using a Scaleway Instance. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/api-cli/migrating-endpoints.mdx b/pages/managed-databases-for-postgresql-and-mysql/api-cli/migrating-endpoints.mdx index 0fe346203e..f971b73f56 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/api-cli/migrating-endpoints.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/api-cli/migrating-endpoints.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + You can migrate your endpoints from a Database Instance to another anytime, using the Scaleway CLI. The following commands are useful when you [upgrade the version of your database engine](/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version/) via the **Upgrade only** option. In this case, you must manually migrate your endpoint. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/api-cli/pg-audit.mdx b/pages/managed-databases-for-postgresql-and-mysql/api-cli/pg-audit.mdx index 0dbe9a7c40..8c94e749a5 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/api-cli/pg-audit.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/api-cli/pg-audit.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + The `pgaudit` extension is available with Scaleway Managed Databases for PostgreSQL. The extension is a powerful monitoring and logging tool that allows you to keep track of the actions happening in your databases, and record them. @@ -22,7 +24,7 @@ The main purpose of `pgaudit` is to allow PostgreSQL users to produce audit logs You can configure the extension to log only what is relevant to your audits. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/api-cli/using-pgcron.mdx b/pages/managed-databases-for-postgresql-and-mysql/api-cli/using-pgcron.mdx index 2a8239db80..c02b613632 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/api-cli/using-pgcron.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/api-cli/using-pgcron.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + The pg_cron extension for PostgreSQL is used to execute periodic tasks. You can schedule SQL tasks, such as queries and data imports, using jobs that run at the intervals you set. On a daily, weekly or monthly basis, for example. The `pg_cron` extension is available with Scaleway Managed Databases for PostgreSQL. The extension is natively loaded in the `shared_preload_libraries` of the Database Instances by default. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/concepts.mdx b/pages/managed-databases-for-postgresql-and-mysql/concepts.mdx index e6f56460df..6c88767c24 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/concepts.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/concepts.mdx @@ -12,6 +12,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Allowed IPs @@ -106,7 +108,7 @@ A Read Replica is a live copy of a Database Instance that behaves like an Instan ## Region and Availability Zone - + ## Relational database diff --git a/pages/managed-databases-for-postgresql-and-mysql/faq.mdx b/pages/managed-databases-for-postgresql-and-mysql/faq.mdx index cb4f17a139..5e28fb29a6 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/faq.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/faq.mdx @@ -9,6 +9,8 @@ dates: category: managed-databases productIcon: PostgresqlMysqlProductIcon --- +import SshBastion from '@macros/databases/ssh-bastion.mdx' + ## What is Scaleway Managed Database for PostgreSQL and MySQL? @@ -147,4 +149,4 @@ You can monitor your [quotas](https://console.scaleway.com/organization/quotas), ## How can I connect to a Database Instance in a Private Network using Public Gateways? - \ No newline at end of file + \ No newline at end of file diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/add-a-database.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/add-a-database.mdx index a03e38b2a1..b7f4379eb6 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/add-a-database.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/add-a-database.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/add-users.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/add-users.mdx index 6a9820efe8..f7b2563f84 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/add-users.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/add-users.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Users can connect to a database and access its data. Each one has a different set of customizable permissions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/apply-maintenance.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/apply-maintenance.mdx index eee3f22649..85de384843 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/apply-maintenance.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/apply-maintenance.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + From time to time your Scaleway Managed Databases have to undergo maintenance to ensure that your nodes are up-to-date and have all the tools necessary to maintain a healthy lifecycle. For example, your engine version might need to be upgraded to the latest available minor version, or certain patches might need to be implemented. These maintenance operations are set up, run, and scheduled by Scaleway, but you can select when to apply them to avoid interruptions during peak times. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type.mdx index fe4b5d3f33..1b11c7bf7f 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + It is possible to change your [volume type](/managed-databases-for-postgresql-and-mysql/concepts/#volume-type) anytime in the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/clone-a-database-instance.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/clone-a-database-instance.mdx index ea8e974ae4..f4add98008 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/clone-a-database-instance.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/clone-a-database-instance.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + The clone feature allows you to create a new Database Instance from an existing one. The clone includes all existing databases, users, and permissions. You can create a clone on a Database Instance larger than your current one. @@ -20,7 +22,7 @@ The clone feature allows you to create a new Database Instance from an existing The clone is fully independent of its parent. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/configure-advanced-settings.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/configure-advanced-settings.mdx index b367d1b3a0..2aa95770ce 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/configure-advanced-settings.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/configure-advanced-settings.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Advanced settings allow you to modify the default configuration of your database engines. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-instance.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-instance.mdx index ba67e205bb..1e70f55db1 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-instance.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-instance.mdx @@ -13,8 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network.mdx index 8c1190a678..0ab344d96f 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/connect-database-private-network.mdx @@ -13,6 +13,9 @@ categories: - managed-databases - postgresql-and-mysql --- +import SshBastion from '@macros/databases/ssh-bastion.mdx' +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/vpc/concepts/#private-networks) allows you to enhance the security of your system's architecture by isolating it from the internet. @@ -22,7 +25,7 @@ This improves performance by reducing the latency between your application and y You can create new Database Instances to attach to your Private Network, or attach existing ones. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -60,7 +63,7 @@ You can create new Database Instances to attach to your Private Network, or atta ## How to connect to a Database Instance through a Public Gateway - + ## How to detach a Database Instance from a Private Network diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/create-a-database.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/create-a-database.mdx index 4a57f9b509..088da3554a 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/create-a-database.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/create-a-database.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Managed Database for PostgreSQL and MySQL provides fully-managed relational Database Instances, with MySQL or PostgreSQL as database engines. @@ -20,7 +22,7 @@ The resource allows you to focus on development rather than administration or co Compared to traditional database management, which requires customers to provide their infrastructure and resources to manage their databases, Managed Database for PostgreSQL and MySQL Instance offers the user access to Database Instances without setting up the hardware or configuring the software. Scaleway handles the provisioning, manages the configuration, and provides useful features, as high availability, automated backup, user management, and more. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica.mdx index be92b9ea2c..6c65098bc2 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + A Read Replica is a live copy of a Database Instance that behaves like an Instance, but that only allows read-only connections. The replica mirrors the data of the primary Database node and any changes made are replicated to the replica asynchronously. Read Replicas allow you to scale your Database Instance for read-heavy database workloads. They can also be used for business intelligence workloads. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-a-database.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-a-database.mdx index 471cde212d..3e84833ecc 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-a-database.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-a-database.mdx @@ -13,8 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-db.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-db.mdx index eefe5f162b..e2800f430c 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-db.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/delete-db.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-autobackup.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-autobackup.mdx index 61b76565ec..a34636fe0e 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-autobackup.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-autobackup.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + With the autobackup feature, the creation and management of your Database Instance backups is automated according to your backup schedule configuration. @@ -24,7 +26,7 @@ Backups are used when your Database Instance's storage option is a Local volume. Although they bear the same feature name, automated snapshots and automated backups are different in their design. If you have a Database Instance using Block Storage, it is only possible to use automated snapshots as autobackup. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-high-availability.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-high-availability.mdx index c9758d3a06..baff96f3d8 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-high-availability.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/enable-high-availability.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - database-instance-management --- +import Requirements from '@macros/iam/requirements.mdx' + You define your Database Instance's node configuration upon its [creation](/managed-databases-for-postgresql-and-mysql/how-to/create-a-database). Two node configuration modes are available with PostgreSQL or MySQL Database Instances. @@ -25,7 +27,7 @@ If you are standalone mode, you can change the node configuration to High Availa Once you upgrade to the High Availability mode, you cannot revert to standalone. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-allowed-ip-addresses.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-allowed-ip-addresses.mdx index cb8f0f6bdd..f6c31146ea 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-allowed-ip-addresses.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-allowed-ip-addresses.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Allowed IPs define remote access restrictions for your Database Instance. The default entry `0.0.0.0/0` enables any host to establish a connection. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-manual-backups.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-manual-backups.mdx index 04992fc947..4384c0ad60 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-manual-backups.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-manual-backups.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Manual backups are useful in cases when you need to have a backup of a specific state of the Database Instance. They can be created for all Database Instances with Local Storage. You can create manual backups for Database Instances with Block Storage if the Database Instance storage is **inferior or equal to 585 GB**. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-permissions.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-permissions.mdx index 9334a13b9a..69ea46a609 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-permissions.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-permissions.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Permissions define the actions a user can perform on a logical database. A database user is generated automatically when you create your Database Instance and this user is attributed all permissions. However, newly created users have no permissions by default. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replica.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replica.mdx index 970d739138..af872f8f83 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replica.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-read-replica.mdx @@ -13,8 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots.mdx index 4cc977f050..6ac0ee713e 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + [Snapshots](/managed-databases-for-postgresql-and-mysql/how-to/manage-snapshots/) allow you to restore data in a new Database Instance, instead of creating individual automated database backups. It is only available for Database Instances that use Block Storage volumes. @@ -20,7 +22,7 @@ When you set up [autobackups](/managed-databases-for-postgresql-and-mysql/how-to You can have up to 100 snapshots per Instance and Project (depending on quotas). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/monitor-databases-cockpit.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/monitor-databases-cockpit.mdx index cfa7042e6a..35fe0ca8ab 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/monitor-databases-cockpit.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/monitor-databases-cockpit.mdx @@ -13,6 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-grafana-rdb.webp' + You can view your Managed Database for PostgreSQL or MySQL metrics and logs using [Scaleway Cockpit](/cockpit/quickstart/). Managed Databases are fully integrated into Cockpit. @@ -23,7 +27,7 @@ Monitoring is available for: This page explains how to get started with Scaleway Cockpit for viewing your Managed Database metrics and logs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -54,7 +58,7 @@ To view your Managed Database's metrics and logs, use the Grafana dashboard whic You are directed to the RDB Overview dashboard. - + Metrics are refreshed every minute, and report on the following data: diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/remove-public-endpoint.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/remove-public-endpoint.mdx index 3e964ecab7..317de74a20 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/remove-public-endpoint.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/remove-public-endpoint.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + When you create a Database Instance, a public endpoint is automatically attributed to it. @@ -20,7 +22,7 @@ For Read Replicas, you can choose whether they take on a public or private endpo If you are using a public endpoint with your Database Instances or Read Replicas, you can remove them anytime in the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [PostgreSQL or MySQL Database Instance](/managed-databases-for-postgresql-and-mysql/quickstart/) @@ -45,7 +47,7 @@ If you are using a public endpoint with your Database Instances or Read Replicas ## From Read Replicas - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Read Replica](/managed-databases-for-postgresql-and-mysql/how-to/create-read-replica/) diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/renew-tls-certificate.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/renew-tls-certificate.mdx index dd7950cac0..be9a65462b 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/renew-tls-certificate.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/renew-tls-certificate.mdx @@ -13,12 +13,14 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + The creation and management of TLS certificates is a feature included in the Managed Database for PostgreSQL offers. A certificate is generated automatically upon the creation of a Database Instance. You can renew your certificates at any time. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-a-database.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-a-database.mdx index 562f204475..3ecec020c4 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-a-database.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-a-database.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + You can upgrade your Database Instances in two ways: by increasing its Block Storage volume or by changing the node type. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version.mdx b/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version.mdx index fee9b9acea..6db73b00c4 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/how-to/upgrade-version.mdx @@ -13,6 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-engine-version-upgrade-pop-up.webp' + If your database engine is outdated, you can upgrade the version to the latest one anytime via the Scaleway console. @@ -26,7 +30,7 @@ The version upgrade is only available for: - Database Instances using Block volumes. If your Database Instance uses a Local volume, you must first [change the volume type](/managed-databases-for-postgresql-and-mysql/how-to/change-volume-type/) to a Block volume and try again. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -62,7 +66,7 @@ We recommend you remove the identified instances before continuing. 2. Select the geographical region of the Instance you want to manage from the drop-down. 3. Click the name of the database whose engine you want to upgrade. The Database Instance information page appears. 4. Click **Upgrade** under **Database engine**. A pop-up appears. - + 5. Select the upgrade method. Two methods are available: - **Upgrade only**: This method has no impact on your original Database Instance. Your Database Instance will remain available with its original endpoint and will continue to be billed. - **Upgrade and switch incoming traffic**: With this method, your endpoint is migrated to the new Database Instance automatically. This option will create a clone of your Database Instance, and will automatically migrate the endpoint to the new Instance. The original Database Instance remains available and will continue to be billed. The endpoint will be deleted from the original Database Instance. diff --git a/pages/managed-databases-for-postgresql-and-mysql/index.mdx b/pages/managed-databases-for-postgresql-and-mysql/index.mdx index 600389dc31..4b250f3f93 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/index.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/index.mdx @@ -50,17 +50,17 @@ meta: - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-postgresql-and-mysql/troubleshooting/index.mdx b/pages/managed-databases-for-postgresql-and-mysql/troubleshooting/index.mdx index 02582b4ec8..b83be2b1d4 100644 --- a/pages/managed-databases-for-postgresql-and-mysql/troubleshooting/index.mdx +++ b/pages/managed-databases-for-postgresql-and-mysql/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: PostgresqlMysqlProductIcon ## Featured Pages - - - - - * Database Instance, you have to specify a user. It will be created with [set permissions](/managed-databases-for-redis/reference-content/default-user-permissions/). You can specify a name for this user when you create a Database Instance. This allows you to ensure the username is compatible with different software integrations where specific usernames are not supported. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/api-cli/using-pub-sub-feature.mdx b/pages/managed-databases-for-redis/api-cli/using-pub-sub-feature.mdx index 8a1f465ec7..990efc0cc2 100644 --- a/pages/managed-databases-for-redis/api-cli/using-pub-sub-feature.mdx +++ b/pages/managed-databases-for-redis/api-cli/using-pub-sub-feature.mdx @@ -12,6 +12,8 @@ categories: - managed-databases - redis --- +import Requirements from '@macros/iam/requirements.mdx' + The Publish/Subscribe feature is available with Redis™* 6 and 7. @@ -23,7 +25,7 @@ Topics describe the data contained within messages, allowing subscribers to choo To implement Pub/Sub using Redis, you can run commands such as `PUBLISH` and `SUBSCRIBE`. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/concepts.mdx b/pages/managed-databases-for-redis/concepts.mdx index 5ca96adfd1..6e528d1c43 100644 --- a/pages/managed-databases-for-redis/concepts.mdx +++ b/pages/managed-databases-for-redis/concepts.mdx @@ -12,6 +12,8 @@ categories: - managed-databases - redis --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Allowed IPs @@ -57,7 +59,7 @@ A configuration directive used to set the maximum amount of memory Redis™ can ## Region and Availability Zone - + ## TCP Keep alive diff --git a/pages/managed-databases-for-redis/faq.mdx b/pages/managed-databases-for-redis/faq.mdx index 3a757c0bde..51b85572e3 100644 --- a/pages/managed-databases-for-redis/faq.mdx +++ b/pages/managed-databases-for-redis/faq.mdx @@ -9,6 +9,11 @@ dates: category: managed-databases productIcon: RedisProductIcon --- +import image from './assets/scaleway-schema-redis.webp' +import image2 from './assets/scaleway-endpoints-redis.webp' +import image3 from './assets/scaleway-redis-node-types.webp' +import image4 from './assets/scaleway-redis-cluster.webp' + ## What is Scaleway Managed Database for Redis™ @@ -25,7 +30,7 @@ The combination of powerful in-memory data storage such as Redis™ and managing One of the most common ways to implement cache is storing frequently accessed data in Redis™ (therefore in memory) and serving your application's request. If data is unavailable in memory, it can always be retrieved from the primary database. Below is a simplified schema explaining this process. - + ## How can I access my Managed Database for Redis™ once it is provisioned? @@ -33,7 +38,7 @@ You can connect to your Managed Database for Redis™ using the IP address(es) a - There are as many `IP:port` endpoints as nodes in your cluster (one if standalone). - If you are in cluster mode (3 nodes or more), you have to use a cluster-specific connector cable to connect to multiple endpoints. - + ## What is the Private Networks feature for Redis™ Database Instances? @@ -77,7 +82,7 @@ Development nodes are suitable for Proofs of Concept (PoCs) and tests. Productio Refer to the image below to see which node types belong to which node class. - + ## What's the difference between High Availability (HA) and Cluster mode? @@ -85,7 +90,7 @@ A Redis™ cluster contains a minimum of 3 nodes and up to 6 nodes. Each node co The cluster nodes use hash partitioning to split the keyspace into key slots. Each replica copies the data of a specific source and can be reassigned to replicate another source or be elected as a source node if needed. This is much better for scaling as the operation is spread across multiple nodes instead of having a single entry point. - + Two-node High Availability configurations are available with Redis™ Database Instances. This configuration type allows you to create a standby node, with an up-to-date replica of the database. If the main node fails for any reason, the standby can take over requests, reducing downtime. diff --git a/pages/managed-databases-for-redis/how-to/configure-advanced-settings-redis.mdx b/pages/managed-databases-for-redis/how-to/configure-advanced-settings-redis.mdx index 681b93ba96..c4950347ed 100644 --- a/pages/managed-databases-for-redis/how-to/configure-advanced-settings-redis.mdx +++ b/pages/managed-databases-for-redis/how-to/configure-advanced-settings-redis.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Advanced settings allow you to modify the default configuration of your Redis™* Database Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/how-to/connect-to-redis-database-instance.mdx b/pages/managed-databases-for-redis/how-to/connect-to-redis-database-instance.mdx index 43cb4eef75..f49e0bee88 100644 --- a/pages/managed-databases-for-redis/how-to/connect-to-redis-database-instance.mdx +++ b/pages/managed-databases-for-redis/how-to/connect-to-redis-database-instance.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - redis --- +import Requirements from '@macros/iam/requirements.mdx' + You can connect to your Redis™* Database Instance using the [Redis™ CLI](https://redis.io/docs/ui/cli/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/how-to/create-a-database-for-redis.mdx b/pages/managed-databases-for-redis/how-to/create-a-database-for-redis.mdx index 6b57803bea..d43d146fa4 100644 --- a/pages/managed-databases-for-redis/how-to/create-a-database-for-redis.mdx +++ b/pages/managed-databases-for-redis/how-to/create-a-database-for-redis.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - redis --- +import Requirements from '@macros/iam/requirements.mdx' + Managed Database for Redis™* is a low-latency caching solution based on in-memory data storage. It allows you to easily set up a secure cache and lighten the load on your main database. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/how-to/delete-a-database-for-redis.mdx b/pages/managed-databases-for-redis/how-to/delete-a-database-for-redis.mdx index 9ad9e63367..3d263fddc2 100644 --- a/pages/managed-databases-for-redis/how-to/delete-a-database-for-redis.mdx +++ b/pages/managed-databases-for-redis/how-to/delete-a-database-for-redis.mdx @@ -13,8 +13,10 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/how-to/manage-allowed-ip-addresses-redis.mdx b/pages/managed-databases-for-redis/how-to/manage-allowed-ip-addresses-redis.mdx index e5c586a813..917cad6632 100644 --- a/pages/managed-databases-for-redis/how-to/manage-allowed-ip-addresses-redis.mdx +++ b/pages/managed-databases-for-redis/how-to/manage-allowed-ip-addresses-redis.mdx @@ -13,10 +13,12 @@ categories: - managed-databases - redis --- +import Requirements from '@macros/iam/requirements.mdx' + Allowed IPs restrict the IPs allowed to access your Redis™* Database Instance. The entry `0.0.0.0/0` enables any host to establish a connection. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/how-to/monitor-redis-databases-cockpit.mdx b/pages/managed-databases-for-redis/how-to/monitor-redis-databases-cockpit.mdx index edb63ea28e..5085cf9789 100644 --- a/pages/managed-databases-for-redis/how-to/monitor-redis-databases-cockpit.mdx +++ b/pages/managed-databases-for-redis/how-to/monitor-redis-databases-cockpit.mdx @@ -13,6 +13,9 @@ categories: - managed-databases - redis --- +import Requirements from '@macros/iam/requirements.mdx' + + You can view your Managed Database for Redis™ metrics and logs using [Scaleway Cockpit](/cockpit/quickstart/). Managed Databases are fully integrated into Cockpit. @@ -23,7 +26,7 @@ Monitoring is available for: This page explains how to get started with Scaleway Cockpit for viewing your Managed Database for Redis™' metrics and logs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -54,7 +57,7 @@ To view your Managed Database's metrics and logs, use the Grafana dashboard whic You are directed to the RDB Overview dashboard. - + Metrics are refreshed every minute, and report on the following data: diff --git a/pages/managed-databases-for-redis/how-to/scale-up-a-database-for-redis.mdx b/pages/managed-databases-for-redis/how-to/scale-up-a-database-for-redis.mdx index b7973c037a..e7828eeaec 100644 --- a/pages/managed-databases-for-redis/how-to/scale-up-a-database-for-redis.mdx +++ b/pages/managed-databases-for-redis/how-to/scale-up-a-database-for-redis.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + If you want to scale up the size of your Redis™* Database Instance, you can edit your node settings to either: @@ -21,7 +23,7 @@ If you want to scale up the size of your Redis™* Database Instance, ## How to scale vertically - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -38,7 +40,7 @@ If you want to scale up the size of your Redis™* Database Instance, ## How to scale horizontally - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/index.mdx b/pages/managed-databases-for-redis/index.mdx index 58f07b7d25..0b0eaa3319 100644 --- a/pages/managed-databases-for-redis/index.mdx +++ b/pages/managed-databases-for-redis/index.mdx @@ -49,7 +49,7 @@ meta: ## Tutorials - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -76,7 +78,7 @@ Managed Database for Redis™ is a low-latency caching solution based on in-memo ## How to delete a Redis™ Database Instance - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-databases-for-redis/troubleshooting/index.mdx b/pages/managed-databases-for-redis/troubleshooting/index.mdx index 82f0b01171..075d119a68 100644 --- a/pages/managed-databases-for-redis/troubleshooting/index.mdx +++ b/pages/managed-databases-for-redis/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: RedisProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Managed Inference deployment](/managed-inference/quickstart/) diff --git a/pages/managed-inference/how-to/create-deployment.mdx b/pages/managed-inference/how-to/create-deployment.mdx index b94d3e5613..68d9e83341 100644 --- a/pages/managed-inference/how-to/create-deployment.mdx +++ b/pages/managed-inference/how-to/create-deployment.mdx @@ -10,8 +10,10 @@ dates: validation: 2025-04-09 posted: 2024-03-06 --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-inference/how-to/delete-deployment.mdx b/pages/managed-inference/how-to/delete-deployment.mdx index 39934c45f8..7a225cab5b 100644 --- a/pages/managed-inference/how-to/delete-deployment.mdx +++ b/pages/managed-inference/how-to/delete-deployment.mdx @@ -12,10 +12,12 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + Once you have finished your inference tasks you can delete your deployment. This page explains how to do so from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Managed Inference deployment](/managed-inference/quickstart/) diff --git a/pages/managed-inference/how-to/import-custom-model.mdx b/pages/managed-inference/how-to/import-custom-model.mdx index dc17bac60b..745ced8c56 100644 --- a/pages/managed-inference/how-to/import-custom-model.mdx +++ b/pages/managed-inference/how-to/import-custom-model.mdx @@ -12,6 +12,8 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway provides a selection of common models for deployment from the Scaleway console. If you need a specific model, you can import it into Managed Inference directly from Hugging Face or a Scaleway Object Storage bucket. @@ -19,7 +21,7 @@ Scaleway provides a selection of common models for deployment from the Scaleway This feature is currently in **beta stage** and will evolve in the future. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) to perform actions in your Organization. diff --git a/pages/managed-inference/how-to/manage-allowed-ips.mdx b/pages/managed-inference/how-to/manage-allowed-ips.mdx index c32e58f5af..37da3a28ea 100644 --- a/pages/managed-inference/how-to/manage-allowed-ips.mdx +++ b/pages/managed-inference/how-to/manage-allowed-ips.mdx @@ -12,10 +12,12 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + Allowed IPs restrict the IPs allowed to access your Managed Inference endpoints. In the absence of allowed IPs, all IP addresses are allowed by default. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Managed Inference deployment](/managed-inference/quickstart/) diff --git a/pages/managed-inference/how-to/managed-inference-with-private-network.mdx b/pages/managed-inference/how-to/managed-inference-with-private-network.mdx index 6d6fa62a07..1cc288a812 100644 --- a/pages/managed-inference/how-to/managed-inference-with-private-network.mdx +++ b/pages/managed-inference/how-to/managed-inference-with-private-network.mdx @@ -12,12 +12,18 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-inference-pn-connected.webp' +import image2 from './assets/scaleway-inference-tls-dl.webp' +import image3 from './assets/scaleway-inference-pn-detach.webp' + In this tutorial, we guide you through the process of attaching a Private Network to your Managed Inference deployment. This can be done during the initial setup or added later to an existing deployment. Using a Private Network for communications between your Instances hosting your applications and the Managed Inference deployment ensures secure communication between resources with low latency. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -55,7 +61,7 @@ Using a Private Network for communications between your Instances hosting your a 1. After attaching a Private Network, go to the **Security** tab. 2. You should see the **Private Network** connected to the deployment resource and its **allocated IPs** listed. - + ## How to send inference requests in a Private Network @@ -64,7 +70,7 @@ Using a Private Network for communications between your Instances hosting your a Ensure the Instance [is attached to the same Private Network](/instances/how-to/use-private-networks/) as your Managed Inference deployment. 2. Download the TLS certificate from your Managed Inference deployment, available from the **Overview** tab in the **Endpoints** section. - + 3. Transfer the TLS certificate to the Instance using the `scp` (secure copy) command to securely transfer the certificate from your local machine to the Scaleway Instance. - Example command: ```bash @@ -139,7 +145,7 @@ Using a Private Network for communications between your Instances hosting your a 2. Click a deployment name or > **More info** to access the deployment dashboard. 3. Go to the **Overview** tab and locate the **Endpoints** section. 4. Click **Detach Private Network**. A pop-up displays. - + 5. Click **Detach Private Network** to confirm the removal of the private endpoint for your deployment. Alternatively, you can access the **Security** tab and detach a network from the **Private Network** section. diff --git a/pages/managed-inference/how-to/monitor-deployment.mdx b/pages/managed-inference/how-to/monitor-deployment.mdx index 17dec12511..45cc94e9d5 100644 --- a/pages/managed-inference/how-to/monitor-deployment.mdx +++ b/pages/managed-inference/how-to/monitor-deployment.mdx @@ -12,10 +12,12 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation page shows you how to monitor your Managed Inference deployment with [Cockpit](/cockpit/quickstart/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Managed Inference deployment](/managed-inference/quickstart/) diff --git a/pages/managed-inference/quickstart.mdx b/pages/managed-inference/quickstart.mdx index 9371107d8e..6265f9bc92 100644 --- a/pages/managed-inference/quickstart.mdx +++ b/pages/managed-inference/quickstart.mdx @@ -11,6 +11,8 @@ dates: categories: - ai-data --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Managed Inference is the first European Managed Inference platform on the market. It is a scalable and secure inference engine for Large Language Models (LLMs). @@ -24,7 +26,7 @@ Here are some of the key features of Scaleway Managed Inference: * **Complete data privacy**: [No storage](/managed-inference/reference-content/data-privacy-security-scaleway-ai-services/#data-storage-policies) or third-party access to your data (prompt or responses), to ensure it remains exclusively yours. * **Interoperability**: Scaleway Managed Inference was designed as a drop-in [replacement for the OpenAI APIs](/managed-inference/reference-content/openai-compatibility/), for a seamless transition on your applications already using its libraries. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/api-cli/backup-and-restore.mdx b/pages/managed-mongodb-databases/api-cli/backup-and-restore.mdx index 8c961c51d2..5ae702403e 100644 --- a/pages/managed-mongodb-databases/api-cli/backup-and-restore.mdx +++ b/pages/managed-mongodb-databases/api-cli/backup-and-restore.mdx @@ -10,6 +10,8 @@ categories: - managed-databases - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Managed MongoDB® provides fully-managed document Database Instances, with a MongoDB®-compatible API layer over a PostgreSQL engine to store and retrieve data. @@ -17,7 +19,7 @@ This means you can use MongoDB® command line tools to use and manage your Mongo This tutorial shows how to backup and restore your MongoDB® Databases with the MongoDB® `mongodump` and `mongorestore` command line database tools. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [MongoDB® Database Instance](/managed-mongodb-databases/how-to/create-a-database-instance/) diff --git a/pages/managed-mongodb-databases/api-cli/cluster-to-cluster-sync.mdx b/pages/managed-mongodb-databases/api-cli/cluster-to-cluster-sync.mdx index 01385c5220..944ed4ea62 100644 --- a/pages/managed-mongodb-databases/api-cli/cluster-to-cluster-sync.mdx +++ b/pages/managed-mongodb-databases/api-cli/cluster-to-cluster-sync.mdx @@ -13,6 +13,8 @@ categories: - managed-databases - mongodb --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Managed MongoDB® is compatible with the [MongoDB® Cluster-to-Cluster tool](https://www.mongodb.com/docs/cluster-to-cluster-sync/current/quickstart/#std-label-c2c-quickstart). @@ -23,7 +25,7 @@ Cluster-to-Cluster sync helps you migrate data from one cluster to another witho Refer to the official PostgreSQL documentation for a list of Cluster-to-Cluster sync's [limitations](https://www.mongodb.com/docs/cluster-to-cluster-sync/current/reference/limitations/#std-label-c2c-limitationsl) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [MongoDB® Database Instance](/managed-mongodb-databases/how-to/create-a-database-instance/) diff --git a/pages/managed-mongodb-databases/concepts.mdx b/pages/managed-mongodb-databases/concepts.mdx index 044a40a719..5b851c1b3f 100644 --- a/pages/managed-mongodb-databases/concepts.mdx +++ b/pages/managed-mongodb-databases/concepts.mdx @@ -9,6 +9,8 @@ tags: concepts managed-databases ferredb mongodb document categories: - managed-databases --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Block Storage Legacy @@ -54,7 +56,7 @@ Compared to traditional database management, which requires customers to provisi ## Region and Availability Zone - + ## Replica-set 1-node diff --git a/pages/managed-mongodb-databases/faq.mdx b/pages/managed-mongodb-databases/faq.mdx index a22a399de6..56e0d544e2 100644 --- a/pages/managed-mongodb-databases/faq.mdx +++ b/pages/managed-mongodb-databases/faq.mdx @@ -9,7 +9,9 @@ dates: category: managed-databases productIcon: MongoDBProductIcon --- +import SshBastionMdb from '@macros/databases/ssh-bastion-mdb.mdx' + ## How can I connect to a Database Instance in a Private Network using Public Gateways? - \ No newline at end of file + \ No newline at end of file diff --git a/pages/managed-mongodb-databases/how-to/connect-database-instance.mdx b/pages/managed-mongodb-databases/how-to/connect-database-instance.mdx index 61110d9300..2e5654b8be 100644 --- a/pages/managed-mongodb-databases/how-to/connect-database-instance.mdx +++ b/pages/managed-mongodb-databases/how-to/connect-database-instance.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/how-to/connect-database-private-network.mdx b/pages/managed-mongodb-databases/how-to/connect-database-private-network.mdx index 1b1f26860b..cc9770b26e 100644 --- a/pages/managed-mongodb-databases/how-to/connect-database-private-network.mdx +++ b/pages/managed-mongodb-databases/how-to/connect-database-private-network.mdx @@ -13,6 +13,9 @@ categories: - managed-databases - mongodb --- +import SshBastionMdb from '@macros/databases/ssh-bastion-mdb.mdx' +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/vpc/concepts/#private-networks) allows you to enhance the security of your system's architecture by isolating it from the internet. @@ -20,7 +23,7 @@ Using Private Networks improves performance by reducing the latency between your You can [create new Database Instances](/managed-mongodb-databases/how-to/create-a-database-instance) to attach to your Private Network, or attach existing ones. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -54,7 +57,7 @@ Once you have attached your Database Instance to a Private Network, you can [con ## How to connect to a Database Instance through a Public Gateway - + ## How to detach a Database Instance from a Private Network diff --git a/pages/managed-mongodb-databases/how-to/create-a-database-instance.mdx b/pages/managed-mongodb-databases/how-to/create-a-database-instance.mdx index dc55a32295..c75ae52561 100644 --- a/pages/managed-mongodb-databases/how-to/create-a-database-instance.mdx +++ b/pages/managed-mongodb-databases/how-to/create-a-database-instance.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' + Managed MongoDB® provides fully-managed document Database Instances, with MongoDB® as a database engine. Document databases enable users to store and retrieve data in a document format, such as `json`. Compared to traditional relational databases where data is stored in a table-like format, document-type storage supports storing multiple nested keys and values in each document key. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/how-to/delete-a-database-instance.mdx b/pages/managed-mongodb-databases/how-to/delete-a-database-instance.mdx index 4e2a62f686..8c85bbc75e 100644 --- a/pages/managed-mongodb-databases/how-to/delete-a-database-instance.mdx +++ b/pages/managed-mongodb-databases/how-to/delete-a-database-instance.mdx @@ -12,8 +12,10 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/how-to/increase-volume.mdx b/pages/managed-mongodb-databases/how-to/increase-volume.mdx index 19dbb7a216..493cfdc182 100644 --- a/pages/managed-mongodb-databases/how-to/increase-volume.mdx +++ b/pages/managed-mongodb-databases/how-to/increase-volume.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' + You can increase the Block Storage volume of your MongoDB® Database Instance in the Scaleway console anytime. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/how-to/manage-snapshots.mdx b/pages/managed-mongodb-databases/how-to/manage-snapshots.mdx index f1efdc5cfc..ff7214dbb4 100644 --- a/pages/managed-mongodb-databases/how-to/manage-snapshots.mdx +++ b/pages/managed-mongodb-databases/how-to/manage-snapshots.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' + [Snapshots](/managed-mongodb-databases/how-to/manage-snapshots/) allow you to restore data in a new Database Instance. You can have up to 100 snapshots per Instance and project (depending on quotas). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/how-to/manage-users.mdx b/pages/managed-mongodb-databases/how-to/manage-users.mdx index b452f4f403..71028edb47 100644 --- a/pages/managed-mongodb-databases/how-to/manage-users.mdx +++ b/pages/managed-mongodb-databases/how-to/manage-users.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-databases --- +import Requirements from '@macros/iam/requirements.mdx' + Users can connect to a database and access its data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/managed-mongodb-databases/index.mdx b/pages/managed-mongodb-databases/index.mdx index c0a2d07a9e..f8f32dd44e 100644 --- a/pages/managed-mongodb-databases/index.mdx +++ b/pages/managed-mongodb-databases/index.mdx @@ -52,7 +52,7 @@ content: ## API and CLI - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/nats/api-cli/nats-cli.mdx b/pages/nats/api-cli/nats-cli.mdx index 15d968c26d..81233fbbac 100644 --- a/pages/nats/api-cli/nats-cli.mdx +++ b/pages/nats/api-cli/nats-cli.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-21 posted: 2023-01-20 --- +import Requirements from '@macros/iam/requirements.mdx' + The NATS CLI (`nats`) is the official NATS tool for managing your NATS resources. It allows you to simply create and manage your streams, consumers and more. @@ -24,7 +26,7 @@ Check out the official [NATS CLI documentation](https://docs.nats.io/using-nats/ This page shows you how to get started with some basic actions via the NATS CLI. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/nats/how-to/create-account.mdx b/pages/nats/how-to/create-account.mdx index cdec7c141b..e208043673 100644 --- a/pages/nats/how-to/create-account.mdx +++ b/pages/nats/how-to/create-account.mdx @@ -13,11 +13,15 @@ dates: validation: 2025-04-01 posted: 2025-04-01 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-nats-create-account.webp' + To start using a NATS message broker, you must first create a NATS account. This sets a scope for your NATS credentials, messages, queues and stream. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -28,7 +32,7 @@ To start using a NATS message broker, you must first create a NATS account. This 2. Click **Create a NATS account**. The creation wizard displays. - + 3. Complete the following steps in the wizard: diff --git a/pages/nats/how-to/create-credentials.mdx b/pages/nats/how-to/create-credentials.mdx index 41d72bb019..cc65fe23f8 100644 --- a/pages/nats/how-to/create-credentials.mdx +++ b/pages/nats/how-to/create-credentials.mdx @@ -13,12 +13,17 @@ dates: validation: 2025-04-01 posted: 2025-04-01 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-nats-overview.webp' +import image2 from './assets/scaleway-nats-creds.webp' + This page shows how to create [credentials](/nats/concepts/#credentials) for Scaleway NATS (previously part of the Messaging and Queuing product). Credentials give their bearer (e.g. services and platforms) access to your service. You can create multiple sets of credentials for each of your NATS accounts. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -34,7 +39,7 @@ Credentials for NATS accounts are not granular: they necessarily give full read 3. Click the NATS account you want to generate credentials for. The account's **Overview** page displays. - + 4. In the **Credentials** panel, click **Generate credentials**. A pop-up displays. @@ -42,7 +47,7 @@ Credentials for NATS accounts are not granular: they necessarily give full read The credentials are created and a button displays prompting you to download them in a `.creds` file. - + The generated credentials are displayed only once. Make sure to download and safely store them before closing the window. diff --git a/pages/nats/how-to/delete-account.mdx b/pages/nats/how-to/delete-account.mdx index feec34a091..56c5212961 100644 --- a/pages/nats/how-to/delete-account.mdx +++ b/pages/nats/how-to/delete-account.mdx @@ -13,11 +13,13 @@ categories: - serverless - nats --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to delete a Scaleway **NATS**, account. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/nats/how-to/manage-credentials.mdx b/pages/nats/how-to/manage-credentials.mdx index 8145c2ce6b..c0d7cba7c1 100644 --- a/pages/nats/how-to/manage-credentials.mdx +++ b/pages/nats/how-to/manage-credentials.mdx @@ -13,6 +13,8 @@ categories: - serverless - nats --- +import Requirements from '@macros/iam/requirements.mdx' + Credentials give their bearer (e.g. services and platforms) access to your service. @@ -20,7 +22,7 @@ This page shows how to manage [credentials](/nats/concepts/#credentials) for Sca Note that the only management action available for NATS credentials is revocation. Once credentials are revoked, any user trying to use the credentials to connect to the service will be denied. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/nats/how-to/monitor-nats-cockpit.mdx b/pages/nats/how-to/monitor-nats-cockpit.mdx index f36990c96e..3738011fb1 100644 --- a/pages/nats/how-to/monitor-nats-cockpit.mdx +++ b/pages/nats/how-to/monitor-nats-cockpit.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-01 posted: 2025-04-01 --- +import Requirements from '@macros/iam/requirements.mdx' + You can view metrics for your NATS services via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your queues/streams and messages at a glance. There are two steps to complete to view your metrics for the first time with Cockpit: @@ -21,7 +23,7 @@ You can view metrics for your NATS services via [Scaleway Cockpit](/cockpit/quic These steps are described below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/nats/index.mdx b/pages/nats/index.mdx index 6bee88e879..5c806f217f 100644 --- a/pages/nats/index.mdx +++ b/pages/nats/index.mdx @@ -4,7 +4,7 @@ meta: description: Explore Scaleway NATS. Simplify your microservice workflows with scalable, reliable, and cost-effective message handling solutions. --- - - \ No newline at end of file +/> diff --git a/pages/nats/quickstart.mdx b/pages/nats/quickstart.mdx index d1326f2a64..816ffdea22 100644 --- a/pages/nats/quickstart.mdx +++ b/pages/nats/quickstart.mdx @@ -13,6 +13,12 @@ categories: - serverless - nats --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-nats-create-account.webp' +import image2 from './assets/scaleway-nats-overview.webp' +import image3 from './assets/scaleway-nats-creds.webp' + Scaleway NATS is a managed message broker tool that allows you to transfer messages between different microservices and platforms. This enables them to "talk" to each other effectively even if they are not otherwise compatible. This enables and simplifies microservices application development and allows you to build highly scalable, reliable, distributed applications. @@ -20,7 +26,7 @@ Scaleway NATS is a managed message broker tool that allows you to transfer messa Scaleway NATS was previously part of our Messaging and Queuing product, and has now become a product in its own right. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -33,7 +39,7 @@ To start using a NATS message broker, you must first create a NATS account. This 2. Click **Create a NATS account**. The creation wizard displays. - + 3. Complete the following steps in the wizard: @@ -54,7 +60,7 @@ Credentials for NATS accounts are not granular: they necessarily give full read 3. Click the NATS account you want to generate credentials for. The account's **Overview** page displays. - + 4. In the **Credentials** panel, click **Generate credentials**. A pop-up displays. @@ -62,7 +68,7 @@ Credentials for NATS accounts are not granular: they necessarily give full read The credentials are created and a button displays prompting you to download them in a `.creds` file. - + The generated credentials are displayed only once. Make sure to download and safely store them before closing the window. diff --git a/pages/nats/troubleshooting/index.mdx b/pages/nats/troubleshooting/index.mdx index 109918b586..2707ee1a37 100644 --- a/pages/nats/troubleshooting/index.mdx +++ b/pages/nats/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: NatsProductIcon ## Featured Pages - - - + The different elements of a bucket policy allow you to [configure fine-grained permissions](/object-storage/api-cli/combining-iam-and-object-storage/) when combined with [Identity and Access Management (IAM)](/iam/concepts/#iam), as shown in the table below. - + Bucket policies behave like objects: they can be uploaded into buckets. Once you upload, or "put" a bucket policy into a bucket, it takes immediate effect and will from then on define who can access and perform actions on the bucket, and the objects it contains. - + ## Bucket policies versions diff --git a/pages/object-storage/api-cli/bucket-website-api.mdx b/pages/object-storage/api-cli/bucket-website-api.mdx index 330a7e7c01..e2f627fe72 100644 --- a/pages/object-storage/api-cli/bucket-website-api.mdx +++ b/pages/object-storage/api-cli/bucket-website-api.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The bucket website feature allows you to host static websites using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/). @@ -20,7 +22,7 @@ It is possible to enable and configure the bucket website feature via the [AWS-C To enable and configure the bucket website using the Scaleway console, refer to our [dedicated documentation](/object-storage/how-to/use-bucket-website/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/combining-iam-and-object-storage.mdx b/pages/object-storage/api-cli/combining-iam-and-object-storage.mdx index a89c926146..41d4fc5af4 100644 --- a/pages/object-storage/api-cli/combining-iam-and-object-storage.mdx +++ b/pages/object-storage/api-cli/combining-iam-and-object-storage.mdx @@ -13,6 +13,11 @@ categories: - storage - object-storage --- +import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx' +import ImportantBucketPolicy from '@macros/storage/important-bucket-policy.mdx' + +import image from './assets/scaleway-bucket-policy-iam-table.webp' + Scaleway Object Storage allows you to manage access to your resources with two features, [Identity and Access Management (IAM)](/iam/concepts/#iam) and [Bucket policies](/object-storage/api-cli/bucket-policy/). @@ -34,11 +39,11 @@ If managing access to resources at the Project level is enough for your Object S ### Bucket policies - + ## Combining IAM and bucket policies - + In order to perform actions on a bucket, a [principal](/object-storage/concepts/#principal) (user or application) must be granted access via an IAM policy, and optionally via a bucket policy. @@ -56,7 +61,7 @@ To set up granular access to your Object Storage resources, you must: 4. [Create and push a bucket policy](/object-storage/api-cli/create-bucket-policy/) in each bucket in which you want fine-grained access. - + ## IAM and bucket policy example diff --git a/pages/object-storage/api-cli/create-bucket-policy.mdx b/pages/object-storage/api-cli/create-bucket-policy.mdx index 9fe1fddb58..48dba50d95 100644 --- a/pages/object-storage/api-cli/create-bucket-policy.mdx +++ b/pages/object-storage/api-cli/create-bucket-policy.mdx @@ -12,12 +12,16 @@ dates: categories: - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' +import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx' +import ImportantBucketPolicy from '@macros/storage/important-bucket-policy.mdx' - + + To create and apply a bucket policy from the [Scaleway console](https://console/scaleway.com), refer to the [dedicated documentation](/object-storage/how-to/create-bucket-policy/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -70,7 +74,7 @@ Make sure that you have [installed and configured the AWS CLI](/object-storage/a ```sh aws s3api put-bucket-policy --bucket --policy file://bucket-policy.json ``` - + 3. Run the command below to display the bucket policy applied to your bucket. ```sh aws s3api get-bucket-policy --bucket --query Policy --output text | jq diff --git a/pages/object-storage/api-cli/enable-sse-c.mdx b/pages/object-storage/api-cli/enable-sse-c.mdx index d3f9f69c05..454cb00df5 100644 --- a/pages/object-storage/api-cli/enable-sse-c.mdx +++ b/pages/object-storage/api-cli/enable-sse-c.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + **S**erver-**S**ide **E**ncryption with **C**ustomer-provided keys (SSE-C) is an encryption method provided by Scaleway Object Storage to protect your data at rest. It allows you to supply your own encryption keys to encrypt data when it is uploaded, and to decrypt data when accessed. @@ -30,7 +32,7 @@ Managing SSE-C using the `aws s3api` command set requires three elements: The encryption key and its digest are sent alongside the data to the cloud storage service. The data is then encrypted using the key provided during the write operation. Once the data has been copied, the encryption key is deleted. The digest of the key is saved with the object's metadata, allowing the data to be decrypted when downloaded. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/generate-aws4-auth-signature.mdx b/pages/object-storage/api-cli/generate-aws4-auth-signature.mdx index c53d716eda..6d00650f40 100644 --- a/pages/object-storage/api-cli/generate-aws4-auth-signature.mdx +++ b/pages/object-storage/api-cli/generate-aws4-auth-signature.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Requests sent to the Object Storage API require an HTTP Authorization header. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/installing-minio-client.mdx b/pages/object-storage/api-cli/installing-minio-client.mdx index fb99a3ab68..0796588889 100644 --- a/pages/object-storage/api-cli/installing-minio-client.mdx +++ b/pages/object-storage/api-cli/installing-minio-client.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc.html) (`mc`) is a command-line tool that allows you to manage your Object Storage projects, providing a modern alternative to UNIX commands. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/pages/object-storage/api-cli/installing-rclone.mdx b/pages/object-storage/api-cli/installing-rclone.mdx index 95163dc7e3..1c1c81bd4c 100644 --- a/pages/object-storage/api-cli/installing-rclone.mdx +++ b/pages/object-storage/api-cli/installing-rclone.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + [Rclone](https://rclone.org) is a command-line tool that can be used to manage your cloud storage. It communicates with any Amazon S3-compatible cloud storage provider as well as other storage platforms. @@ -31,7 +33,7 @@ For example, on Linux: mv rclone /usr/bin/ ``` - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/lifecycle-rules-api.mdx b/pages/object-storage/api-cli/lifecycle-rules-api.mdx index 8a9764b286..2e3fcd00e2 100644 --- a/pages/object-storage/api-cli/lifecycle-rules-api.mdx +++ b/pages/object-storage/api-cli/lifecycle-rules-api.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Object Storage bucket](/object-storage/how-to/create-a-bucket/) diff --git a/pages/object-storage/api-cli/manage-bucket-permissions-ip.mdx b/pages/object-storage/api-cli/manage-bucket-permissions-ip.mdx index c904f554f3..128ea68c80 100644 --- a/pages/object-storage/api-cli/manage-bucket-permissions-ip.mdx +++ b/pages/object-storage/api-cli/manage-bucket-permissions-ip.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can stipulate which IP addresses or IP ranges have access or permission to perform operations on your buckets by creating a [bucket policy](/object-storage/api-cli/bucket-policy/) with the `IpAddress` or `NotIpAddress` conditions. @@ -22,7 +24,7 @@ It is possible to `Allow` actions for a specific IP address or range of IPs, usi The `aws:SourceIp` IPv4 and IPv6 values use the standard [CIDR notation](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). For IPv6, we support using the double colon (`::`) to represent strings of `0`. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/managing-lifecycle-cliv2.mdx b/pages/object-storage/api-cli/managing-lifecycle-cliv2.mdx index efc19cb6ff..e6f99b00a4 100644 --- a/pages/object-storage/api-cli/managing-lifecycle-cliv2.mdx +++ b/pages/object-storage/api-cli/managing-lifecycle-cliv2.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Object Storage](/object-storage/concepts/#object-storage) is a service based on the Amazon S3 protocol. It allows you to store different types of objects (documents, images, videos, etc.) and distribute them instantly, anywhere in the world. You can create and manage your Object Storage resources from the [console](https://account.scaleway.com/login), or via the [Scaleway Command Line Interface](/scaleway-cli/quickstart/) that uses external tools such as [S3cmd](https://github.com/s3tools/s3cmd), [Rclone](https://rclone.org/downloads/) or [MinIO Client (mc)](https://github.com/minio/mc). @@ -20,7 +22,7 @@ categories: [The Scaleway Command Line Interface (CLI)](/scaleway-cli/quickstart/) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and is an essential tool for operating efficiently in your cloud environment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/migrating-buckets.mdx b/pages/object-storage/api-cli/migrating-buckets.mdx index a89c26c871..f47992a269 100644 --- a/pages/object-storage/api-cli/migrating-buckets.mdx +++ b/pages/object-storage/api-cli/migrating-buckets.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/multipart-uploads.mdx b/pages/object-storage/api-cli/multipart-uploads.mdx index bac221e61f..389670b6f5 100644 --- a/pages/object-storage/api-cli/multipart-uploads.mdx +++ b/pages/object-storage/api-cli/multipart-uploads.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Multipart uploads allow you to upload large files to the Object Storage platform by dividing them into multiple fragments to improve throughput and recover quickly in case of network interruption. @@ -29,7 +31,7 @@ The following technical specifications apply to multipart uploads: - 5 MB to 5 GB per part (except for the last one) - Each object stores up to 5 TB - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Installed the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/) diff --git a/pages/object-storage/api-cli/object-lock.mdx b/pages/object-storage/api-cli/object-lock.mdx index 9543b6ca4f..6e8c05b0a2 100644 --- a/pages/object-storage/api-cli/object-lock.mdx +++ b/pages/object-storage/api-cli/object-lock.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The **object lock** feature allows users to lock objects and prevent them from being deleted or overwritten. Objects can be put on lock for a specific amount of time or indefinitely. The lock period is defined by the user. @@ -24,7 +26,7 @@ Setting object lock can only be achieved upon the creation of a bucket. In addit Object Lock can be used with `Standard`, `One Zone - IA` (`fr-par`) and `Glacier` [storage classes](/object-storage/concepts/#storage-class). - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Installed the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/) diff --git a/pages/object-storage/api-cli/object-storage-aws-cli.mdx b/pages/object-storage/api-cli/object-storage-aws-cli.mdx index 25977f7eef..b0004b98d1 100644 --- a/pages/object-storage/api-cli/object-storage-aws-cli.mdx +++ b/pages/object-storage/api-cli/object-storage-aws-cli.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The AWS-CLI is an open-source tool built on top of the [AWS SDK for Python (Boto)](https://boto3.amazonaws.com/v1/documentation/api/latest/index.html) that provides commands for interacting with AWS services. With minimal configuration, you can start using all the functionalities provided by AWS Management. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/post-object.mdx b/pages/object-storage/api-cli/post-object.mdx index 0744b0dbd0..6c5ff7a5c3 100644 --- a/pages/object-storage/api-cli/post-object.mdx +++ b/pages/object-storage/api-cli/post-object.mdx @@ -13,12 +13,16 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-post-object-use-case.webp' + The POST object operation adds an object to a specified bucket using HTML forms. POST is an alternate form of PUT that enables browser-based uploads as a way of putting objects directly in buckets. Parameters that are passed to PUT via HTTP Headers are instead passed as form fields to POST in the multipart/form-data encoded message body. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -26,7 +30,7 @@ Parameters that are passed to PUT via HTTP Headers are instead passed as form fi You must have WRITE access to a bucket to add an object to it. - + | Fields | Description | Required | | --------------------------------- | ----------------------------------------------------------------------------------------- | -------- | diff --git a/pages/object-storage/api-cli/setting-cors-rules.mdx b/pages/object-storage/api-cli/setting-cors-rules.mdx index 2780b15cf4..0744c36b09 100644 --- a/pages/object-storage/api-cli/setting-cors-rules.mdx +++ b/pages/object-storage/api-cli/setting-cors-rules.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The [CORS standard](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) describes new HTTP headers that provide browsers a way to request remote URLs only when they have permission. Although some validation and authorization can be performed by the server, it is generally the browser's responsibility to support these headers and honor the restrictions they impose. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/api-cli/share-buckets-read-only.mdx b/pages/object-storage/api-cli/share-buckets-read-only.mdx index d3da1b78e1..746b1e5338 100644 --- a/pages/object-storage/api-cli/share-buckets-read-only.mdx +++ b/pages/object-storage/api-cli/share-buckets-read-only.mdx @@ -10,12 +10,14 @@ dates: validation: 2025-02-11 posted: 2021-05-19 --- +import Requirements from '@macros/iam/requirements.mdx' + Bucket policy version `2012-10-17` is deprecated and its usage is not recommended. Refer to the [dedicated documentation](/object-storage/api-cli/bucket-policy/#bucket-policies-versions) for more information on bucket policy versions. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Installed the [AWS CLI](/object-storage/api-cli/object-storage-aws-cli/) diff --git a/pages/object-storage/api-cli/using-api-call-list.mdx b/pages/object-storage/api-cli/using-api-call-list.mdx index 8677ec8a77..ef4ebb2b20 100644 --- a/pages/object-storage/api-cli/using-api-call-list.mdx +++ b/pages/object-storage/api-cli/using-api-call-list.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + In this page we index all available Scaleway Object Storage API requests. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/concepts.mdx b/pages/object-storage/concepts.mdx index 5f4c8ca80c..7e63596c59 100644 --- a/pages/object-storage/concepts.mdx +++ b/pages/object-storage/concepts.mdx @@ -13,6 +13,9 @@ categories: - storage - object-storage --- +import RegionAndAz from '@macros/console/region-and-az.mdx' +import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx' + ## Access control list (ACL) @@ -26,7 +29,7 @@ Buckets can contain as many objects as you want. Refer to our [dedicated documen ## Bucket policy - + Bucket policies are assigned to [principals](#principal), who will be allowed or denied access to resources and actions. They can be created and applied using the [CLI](/object-storage/api-cli/create-bucket-policy/) or via the [Scaleway console](/object-storage/how-to/create-bucket-policy/). @@ -136,7 +139,7 @@ A principal is the target of a [bucket policy](#bucket-policy). They acquire the ## Region and Availability Zone - + ## Retention modes diff --git a/pages/object-storage/how-to/abort-incomplete-mpu.mdx b/pages/object-storage/how-to/abort-incomplete-mpu.mdx index 8a835f2b0c..e9fcbf5b5e 100644 --- a/pages/object-storage/how-to/abort-incomplete-mpu.mdx +++ b/pages/object-storage/how-to/abort-incomplete-mpu.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The [Scaleway console](https://console.scaleway.com/) lists your Object Storage incomplete multipart uploads to allow you to consult them, and manually abort them to clear storage space and optimize your storage costs. @@ -22,7 +24,7 @@ Incomplete multipart uploads are charged even though they are not finished, as t You can automate the process of aborting incomplete multipart uploads using [lifecycle rules](/object-storage/how-to/manage-lifecycle-rules). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/access-objects-via-https.mdx b/pages/object-storage/how-to/access-objects-via-https.mdx index 2f0490b3f7..f07d47561a 100644 --- a/pages/object-storage/how-to/access-objects-via-https.mdx +++ b/pages/object-storage/how-to/access-objects-via-https.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Object Storage allows you to access your objects via HTTPS. @@ -20,7 +22,7 @@ If an object is [private](/object-storage/how-to/manage-object-visibility/), you If an object is public, you can retrieve the link to access it from the [Scaleway console](https://console.scaleway.com). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Created an Object Storage bucket](/object-storage/how-to/create-a-bucket/) and have [uploaded objects](object-storage/how-to/upload-files-into-a-bucket/) to it diff --git a/pages/object-storage/how-to/create-a-bucket.mdx b/pages/object-storage/how-to/create-a-bucket.mdx index db832da29d..d4d3bb5efe 100644 --- a/pages/object-storage/how-to/create-a-bucket.mdx +++ b/pages/object-storage/how-to/create-a-bucket.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Object Storage allows you to store different types of objects (documents, images, videos, etc.) and distribute them instantly, anywhere in the world. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/create-bucket-policy.mdx b/pages/object-storage/how-to/create-bucket-policy.mdx index 1d5128f8d5..dfa45063f8 100644 --- a/pages/object-storage/how-to/create-bucket-policy.mdx +++ b/pages/object-storage/how-to/create-bucket-policy.mdx @@ -13,14 +13,18 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' +import StorageBucketPolicy from '@macros/storage/bucket-policy.mdx' +import ImportantBucketPolicy from '@macros/storage/important-bucket-policy.mdx' + Scaleway Object Storage allows you to create [bucket policies](/object-storage/concepts/#bucket-policy) directly from the [Scaleway console](https://console.scaleway.com). To create and apply a bucket policy from the AWS CLI, refer to the [dedicated documentation](/object-storage/api-cli/create-bucket-policy/). - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - [Created a bucket](/object-storage/how-to/create-a-bucket/) @@ -120,7 +124,7 @@ To create and apply a bucket policy from the AWS CLI, refer to the [dedicated do 10. Click **Create bucket policy** to create it, and apply it to the selected bucket. - + ## Bucket policy example @@ -213,7 +217,7 @@ The [Scaleway console](https://console/scaleway.com) allows you to duplicate an 6. Click **Apply policy**. - + ## How to delete a bucket policy diff --git a/pages/object-storage/how-to/delete-a-bucket.mdx b/pages/object-storage/how-to/delete-a-bucket.mdx index e5a1617104..d7c6d422fd 100644 --- a/pages/object-storage/how-to/delete-a-bucket.mdx +++ b/pages/object-storage/how-to/delete-a-bucket.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/delete-an-object.mdx b/pages/object-storage/how-to/delete-an-object.mdx index 8fa9612cef..2e2547aa24 100644 --- a/pages/object-storage/how-to/delete-an-object.mdx +++ b/pages/object-storage/how-to/delete-an-object.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/download-files-from-a-bucket.mdx b/pages/object-storage/how-to/download-files-from-a-bucket.mdx index 928e1005e6..97796bfe47 100644 --- a/pages/object-storage/how-to/download-files-from-a-bucket.mdx +++ b/pages/object-storage/how-to/download-files-from-a-bucket.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/edit-storage-class.mdx b/pages/object-storage/how-to/edit-storage-class.mdx index da1add50d2..b5a2ee12e8 100644 --- a/pages/object-storage/how-to/edit-storage-class.mdx +++ b/pages/object-storage/how-to/edit-storage-class.mdx @@ -13,6 +13,8 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Object Storage offers several [storage classes](/object-storage/concepts/#storage-class) to choose from depending on the performance, access, resiliency, and cost requirements of your workloads. The [Scaleway console](https://console/) allows you to edit the storage class of objects individually. @@ -20,7 +22,7 @@ Scaleway Object Storage offers several [storage classes](/object-storage/concept To change the storage class of several or all objects in a bucket, create a [lifecycle rule](/object-storage/how-to/manage-lifecycle-rules/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/get-started-edge-services.mdx b/pages/object-storage/how-to/get-started-edge-services.mdx index cf9cec2a3d..df651c698c 100644 --- a/pages/object-storage/how-to/get-started-edge-services.mdx +++ b/pages/object-storage/how-to/get-started-edge-services.mdx @@ -13,14 +13,20 @@ categories: - storage - object-storage --- +import EdgeServicesBucketBenefits from '@macros/edge-services/edge-services-bucket-benefits.mdx' +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-edge-services-select-bucket.webp' +import image2 from './assets/scaleway-edge-services-os-splash.webp' + Edge Services is an additional feature for Scaleway Load Balancers and Object Storage buckets. Creating an Edge Services pipeline towards your Object Storage bucket brings you a number of possible benefits: - + Read on to learn how to create an Edge Services pipeline for your Object Storage bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -43,11 +49,11 @@ You can create an Edge Services pipeline from the **Edge Services** section of t 1. Click **Object Storage** in the **Storage** section of the [Scaleway console](https://console.scaleway.com/) side menu. 2. Click the name of the bucket you want to create an Edge Services pipeline for. - + 3. Click the **Edge Services** tab. - + 4. Click **Create pipeline**. diff --git a/pages/object-storage/how-to/manage-lifecycle-rules.mdx b/pages/object-storage/how-to/manage-lifecycle-rules.mdx index e4c80381d5..a115f44872 100644 --- a/pages/object-storage/how-to/manage-lifecycle-rules.mdx +++ b/pages/object-storage/how-to/manage-lifecycle-rules.mdx @@ -13,12 +13,14 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + With the Scaleway console, you can use lifecycle rules to [manually](/object-storage/how-to/edit-storage-class/) or automatically change the storage class of your objects. These rules also allow users to set expiration dates for objects and their versions. Lifecycle rules also allow you to automatically abort incomplete [multipart uploads](/object-storage/api-cli/multipart-uploads/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/manage-object-visibility.mdx b/pages/object-storage/how-to/manage-object-visibility.mdx index a3d7676619..b78c2e8c4a 100644 --- a/pages/object-storage/how-to/manage-object-visibility.mdx +++ b/pages/object-storage/how-to/manage-object-visibility.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Object visibility specifies whether your object is visible to others or not, independently from [bucket visibility](/object-storage/concepts/#visibility). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/monitor-consumption.mdx b/pages/object-storage/how-to/monitor-consumption.mdx index 1c5cdc32b9..cc8b2a9192 100644 --- a/pages/object-storage/how-to/monitor-consumption.mdx +++ b/pages/object-storage/how-to/monitor-consumption.mdx @@ -13,12 +13,14 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + You can view your Object Storage's metrics and logs using [Scaleway Cockpit](/cockpit/quickstart/). Scaleway Object Storage is fully integrated into Cockpit, and allows you to monitor your objects, storage usage, and bandwidth at a glance. This page explains how to get started with Scaleway Cockpit for viewing your Object Storage metrics and logs. Cockpit is available in all [regions](/object-storage/concepts/#region-and-availability-zone) for Object Storage. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/restore-an-object-from-glacier.mdx b/pages/object-storage/how-to/restore-an-object-from-glacier.mdx index 7e7f76f929..c963be65b2 100644 --- a/pages/object-storage/how-to/restore-an-object-from-glacier.mdx +++ b/pages/object-storage/how-to/restore-an-object-from-glacier.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/upload-files-into-a-bucket.mdx b/pages/object-storage/how-to/upload-files-into-a-bucket.mdx index d8160c824a..9709408017 100644 --- a/pages/object-storage/how-to/upload-files-into-a-bucket.mdx +++ b/pages/object-storage/how-to/upload-files-into-a-bucket.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to upload files into an Object Storage bucket using the [Scaleway console](https://consol.scaleway.com). To upload an object using the Amazon S3 API, refer to the [dedicated documentation](/object-storage/api-cli/object-operations/#putobject). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/use-bucket-versioning.mdx b/pages/object-storage/how-to/use-bucket-versioning.mdx index a6bcf6f886..5815097cbf 100644 --- a/pages/object-storage/how-to/use-bucket-versioning.mdx +++ b/pages/object-storage/how-to/use-bucket-versioning.mdx @@ -13,12 +13,14 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + Versioning is a feature designed to keep multiple variants of an object in the same bucket. When enabled, it allows you to store, retrieve, and restore every version of your objects stored in a bucket. Versioning allows you to easily recover your objects in case of unintended user actions or application failures. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/use-bucket-website.mdx b/pages/object-storage/how-to/use-bucket-website.mdx index 0f43089f82..e103abfc2f 100644 --- a/pages/object-storage/how-to/use-bucket-website.mdx +++ b/pages/object-storage/how-to/use-bucket-website.mdx @@ -13,10 +13,12 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The Bucket Website feature allows you to host [static websites](https://en.wikipedia.org/wiki/Static_web_page) using Scaleway [Object Storage](https://www.scaleway.com/en/object-storage/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/how-to/use-obj-stor-with-private-networks.mdx b/pages/object-storage/how-to/use-obj-stor-with-private-networks.mdx index f83df42ced..e0814fa9fa 100644 --- a/pages/object-storage/how-to/use-obj-stor-with-private-networks.mdx +++ b/pages/object-storage/how-to/use-obj-stor-with-private-networks.mdx @@ -13,12 +13,14 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' + The [Public Gateway](/public-gateways/concepts/#public-gateway) feature of the [Private Networks](/vpc/concepts/#private-networks) allows Instances in your Private Network to reach resources on the internet without using a public IP address. This documentation shows how to create an Instance without a public IP address, create a Private Network with a Public Gateway, and a route from your Instance to an Object Storage bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/index.mdx b/pages/object-storage/index.mdx index 3a258a1587..8f9ff0f79e 100644 --- a/pages/object-storage/index.mdx +++ b/pages/object-storage/index.mdx @@ -4,7 +4,7 @@ meta: description: Explore comprehensive documentation covering Scaleway Object Storage features and usage. --- - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/api-key-does-not-work.mdx b/pages/object-storage/troubleshooting/api-key-does-not-work.mdx index e3d3857ebd..2b548dfb9d 100644 --- a/pages/object-storage/troubleshooting/api-key-does-not-work.mdx +++ b/pages/object-storage/troubleshooting/api-key-does-not-work.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/cannot-access-data.mdx b/pages/object-storage/troubleshooting/cannot-access-data.mdx index 9776478f0d..cd9d9ebbbe 100644 --- a/pages/object-storage/troubleshooting/cannot-access-data.mdx +++ b/pages/object-storage/troubleshooting/cannot-access-data.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/cannot-delete-bucket.mdx b/pages/object-storage/troubleshooting/cannot-delete-bucket.mdx index 709e312f52..8442fa38b3 100644 --- a/pages/object-storage/troubleshooting/cannot-delete-bucket.mdx +++ b/pages/object-storage/troubleshooting/cannot-delete-bucket.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/cannot-restore-glacier.mdx b/pages/object-storage/troubleshooting/cannot-restore-glacier.mdx index 51a0976c29..0a997fb591 100644 --- a/pages/object-storage/troubleshooting/cannot-restore-glacier.mdx +++ b/pages/object-storage/troubleshooting/cannot-restore-glacier.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/error-messages-access.mdx b/pages/object-storage/troubleshooting/error-messages-access.mdx index ba5e7a37bf..1ddaeb98a4 100644 --- a/pages/object-storage/troubleshooting/error-messages-access.mdx +++ b/pages/object-storage/troubleshooting/error-messages-access.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/index.mdx b/pages/object-storage/troubleshooting/index.mdx index c0a93d37b3..927ad1c98e 100644 --- a/pages/object-storage/troubleshooting/index.mdx +++ b/pages/object-storage/troubleshooting/index.mdx @@ -21,19 +21,19 @@ productIcon: ObjectStorageProductIcon ## Featured Pages - - - - - - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/lost-bucket-access-bucket-policy.mdx b/pages/object-storage/troubleshooting/lost-bucket-access-bucket-policy.mdx index 7a641ccf67..19bf2945e3 100644 --- a/pages/object-storage/troubleshooting/lost-bucket-access-bucket-policy.mdx +++ b/pages/object-storage/troubleshooting/lost-bucket-access-bucket-policy.mdx @@ -13,8 +13,11 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' +import ImportantBucketPolicy from '@macros/storage/important-bucket-policy.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -24,7 +27,7 @@ When [creating and applying a bucket policy](/object-storage/api-cli/create-buck [Bucket policies](/object-storage/api-cli/bucket-policy/) automatically deny actions to users who are not explicitly allowed by a [statement](/object-storage/api-cli/bucket-policy/#statement). - + ## Cause diff --git a/pages/object-storage/troubleshooting/low-performance.mdx b/pages/object-storage/troubleshooting/low-performance.mdx index 6ca3f3d270..ba50d1db1a 100644 --- a/pages/object-storage/troubleshooting/low-performance.mdx +++ b/pages/object-storage/troubleshooting/low-performance.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/object-storage/troubleshooting/request-rate-error.mdx b/pages/object-storage/troubleshooting/request-rate-error.mdx index 16f96f7a86..8980583876 100644 --- a/pages/object-storage/troubleshooting/request-rate-error.mdx +++ b/pages/object-storage/troubleshooting/request-rate-error.mdx @@ -13,8 +13,10 @@ categories: - storage - object-storage --- +import Requirements from '@macros/iam/requirements.mdx' - + + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/additional-content/organization-quotas.mdx b/pages/organizations-and-projects/additional-content/organization-quotas.mdx index 091a239efe..4c1d1161a7 100644 --- a/pages/organizations-and-projects/additional-content/organization-quotas.mdx +++ b/pages/organizations-and-projects/additional-content/organization-quotas.mdx @@ -12,6 +12,26 @@ dates: categories: - console --- +import ComputeAppleSiliconM1 from '@macros/compute/apple-silicon-m1.mdx' +import ComputeContainerRegistry from '@macros/compute/container-registry.mdx' +import ComputeElasticMetal from '@macros/compute/elastic-metal.mdx' +import ComputeGpuInstances from '@macros/compute/gpu-instances.mdx' +import ComputeInstances from '@macros/compute/instances.mdx' +import ComputeKubernetes from '@macros/compute/kubernetes.mdx' +import ComputeServerlessContainers from '@macros/compute/serverless-containers.mdx' +import ComputeServerlessFunctions from '@macros/compute/serverless-functions.mdx' +import ComputeServerlessJobs from '@macros/compute/serverless-jobs.mdx' +import ConsoleProjects from '@macros/console/projects.mdx' +import ConsoleSmtp from '@macros/console/smtp.mdx' +import ConsoleSshKeys from '@macros/console/ssh-keys.mdx' +import NetworkEdgeServices from '@macros/edge-services/network-edge-services.mdx' +import IotHubIot from '@macros/iot-hub/iot.mdx' +import NetworkDnsCloud from '@macros/network/dns-cloud.mdx' +import NetworkLoadBalancer from '@macros/network/load-balancer.mdx' +import NetworkPublicGateways from '@macros/network/public-gateways.mdx' +import StorageManagedDatabases from '@macros/storage/managed-databases.mdx' +import StorageObjectStorage from '@macros/storage/object-storage.mdx' + Every [Organization](/iam/concepts/#organization) has quotas, which are limits on the number of Scaleway resources they can use. Below is a list of quotas available for each resource. @@ -43,7 +63,7 @@ At Scaleway, quotas are applicable per [Organization](/iam/concepts/#organizatio ## Projects - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -56,7 +76,7 @@ At Scaleway, quotas are applicable per [Organization](/iam/concepts/#organizatio ## SSH keys - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -64,7 +84,7 @@ At Scaleway, quotas are applicable per [Organization](/iam/concepts/#organizatio ## SMTP - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -72,7 +92,7 @@ At Scaleway, quotas are applicable per [Organization](/iam/concepts/#organizatio ## Instances - + Quotas are applied manually for Enterprise (ENT) range Instances to Organizations that have their [identity validated](/account/how-to/verify-identity/). [Contact our support team.](https://console.scaleway.com/support/create) @@ -129,7 +149,7 @@ At Scaleway, quotas are applicable per [Organization](/iam/concepts/#organizatio ## GPU Instances - + [Contact our support team](https://console.scaleway.com/support/create) if you want to increase your quotas to more than 1. @@ -215,7 +235,7 @@ Generative APIs are rate limited based on: ## Apple silicon - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |-------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -228,7 +248,7 @@ Generative APIs are rate limited based on: ## Elastic Metal - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |-----------------|:----------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------------------------:| @@ -275,7 +295,7 @@ After you order a server from the list of Elastic Metal servers compatible with ## Kubernetes - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |------------------------------------------------------|:-----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------------------------------:| @@ -288,7 +308,7 @@ After you order a server from the list of Elastic Metal servers compatible with ## Container Registry - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -298,7 +318,7 @@ After you order a server from the list of Elastic Metal servers compatible with ## Serverless Containers - + #### Resources quotas @@ -318,7 +338,7 @@ For example, if you choose to create a container with 512 MB of memory and a max ## Serverless Functions - + #### Resources quotas @@ -339,7 +359,7 @@ For example, if you choose to create a container with 512 MB of memory and a max ## Serverless Jobs - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | @@ -416,7 +436,7 @@ Local and Block Storage options are available with our compute offers. ## Object Storage - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |---------------------------|:-----------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------:| @@ -424,7 +444,7 @@ Local and Block Storage options are available with our compute offers. ## Database Instances - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card ) | Payment method and [identity validated](/account/how-to/verify-identity/) | |---------------------------|:------------------------------------------------------------------------------------------------------------:|:------------------------------------------------------------------------------------:| @@ -453,7 +473,7 @@ Additional IP addresses and placement groups are available with our compute offe ## Public Gateways - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:-----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -466,7 +486,7 @@ Additional IP addresses and placement groups are available with our compute offe ## Load Balancers - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |---------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -474,7 +494,7 @@ Additional IP addresses and placement groups are available with our compute offe ## Edge Services - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |---------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -482,7 +502,7 @@ Additional IP addresses and placement groups are available with our compute offe ## Domains and DNS - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |--------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| @@ -494,7 +514,7 @@ Additional IP addresses and placement groups are available with our compute offe ## IoT Hub - + | | [Payment method validated](/billing/how-to/add-payment-method/#how-to-add-a-credit-card) | Payment method and [identity validated](/account/how-to/verify-identity/) | |---------------------------|:----------------------------------------------------------------------------------------------------------:|:-------------------------------------------------------------:| diff --git a/pages/organizations-and-projects/api-cli/managing-projects.mdx b/pages/organizations-and-projects/api-cli/managing-projects.mdx index 673c23750e..f1fd9f681f 100644 --- a/pages/organizations-and-projects/api-cli/managing-projects.mdx +++ b/pages/organizations-and-projects/api-cli/managing-projects.mdx @@ -12,10 +12,12 @@ dates: categories: - IAM --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage Projects using [Scaleway APIs](https://www.scaleway.com/en/developers/api/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Configured your API keys](/iam/how-to/create-api-keys/) diff --git a/pages/organizations-and-projects/concepts.mdx b/pages/organizations-and-projects/concepts.mdx index 9d2b407f1b..ea7f3d1ade 100644 --- a/pages/organizations-and-projects/concepts.mdx +++ b/pages/organizations-and-projects/concepts.mdx @@ -11,6 +11,8 @@ dates: categories: - console --- +import image from './assets/scaleway-iam-organization.webp' + ## Default Project @@ -22,7 +24,7 @@ An Organization is made of one or several [Projects](#project). When you create When you create [IAM rules](#rule), you can set their scope at Organization level. This means you can give access to features managed at Organization level, like billing and IAM, to users, applications, and groups in your Organization. - + ## Organization ID diff --git a/pages/organizations-and-projects/how-to/add-resources-project.mdx b/pages/organizations-and-projects/how-to/add-resources-project.mdx index 45b2ed0fea..c5d6a7a35e 100644 --- a/pages/organizations-and-projects/how-to/add-resources-project.mdx +++ b/pages/organizations-and-projects/how-to/add-resources-project.mdx @@ -12,8 +12,10 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/how-to/change-project-name.mdx b/pages/organizations-and-projects/how-to/change-project-name.mdx index cea03b2d12..558346157e 100644 --- a/pages/organizations-and-projects/how-to/change-project-name.mdx +++ b/pages/organizations-and-projects/how-to/change-project-name.mdx @@ -12,8 +12,10 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/how-to/create-a-project.mdx b/pages/organizations-and-projects/how-to/create-a-project.mdx index 34e3d3ef91..30ad828dab 100644 --- a/pages/organizations-and-projects/how-to/create-a-project.mdx +++ b/pages/organizations-and-projects/how-to/create-a-project.mdx @@ -12,6 +12,8 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + If you have a [Scaleway account](/account/how-to/create-an-account/), and subsequently an [Organization](/iam/concepts/#organization), you will also automatically have a [default Project](/organizations-and-projects/concepts/#default-project), that contains all your existing [resources](/iam/concepts/#resource). You can also create additional Projects, allowing you to group your resources. @@ -19,7 +21,7 @@ If you have a [Scaleway account](/account/how-to/create-an-account/), and subseq The default Project inherits the Organization ID. Therefore, the **default** status cannot be transferred to other Projects. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/how-to/create-ssh-key.mdx b/pages/organizations-and-projects/how-to/create-ssh-key.mdx index 2dcf268deb..b8a18753cb 100644 --- a/pages/organizations-and-projects/how-to/create-ssh-key.mdx +++ b/pages/organizations-and-projects/how-to/create-ssh-key.mdx @@ -12,6 +12,14 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-puttygen-app.webp' +import image2 from './assets/scaleway-puttygen-01.webp' +import image3 from './assets/scaleway-puttygen-02.webp' +import image4 from './assets/scaleway-puttygen-03.webp' +import image5 from './assets/scaleway-orga-drop-down.webp' + [SSH keys](/organizations-and-projects/concepts/#ssh-key) allow you to securely connect to your Instances, Elastic Metal servers, and Mac minis without using a password. An SSH key consists of a key pair, which has two elements: @@ -26,7 +34,7 @@ We recommend you use either: - an [RSA SSH key pair](#how-to-generate-a-rsa-ssh-key-pair), to connect to your Windows-based Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -92,15 +100,15 @@ Ed25519 SSH key pairs allow you to connect to your Linux-based Instances from a On Windows, you can use the third-party application [PuTTYgen](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to generate an SSH key pair. 1. Download and install [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) on your local computer. The **PuTTYgen** application is automatically installed along with the main PuTTY application. - + 2. Launch PuTTYgen by double-clicking the application icon. 3. Select **EdDSA** and click the **Generate** button. You can also add a passphrase before generating the key to increase security. - + 4. Move the mouse around the blank area as instructed to generate randomness. - + The public and private key are generated, and the following screen will display: - + 5. Complete the steps on the screen to finish: - Fill in the **Key comment** field with a name to help you identify this key pair. - Click the **Save public key** button and save it in the folder of your choice. @@ -147,7 +155,7 @@ You must upload the content of the public part of the SSH key pair you just gene Check if you are in the right Project before proceeding. You can check your current Organization and Project in the top-left corner of the Scaleway console. If you wish to change your Project, click the current Project name in the breadcrumb navigation and select a different existing Project in the drop-down. Click **Create Project** to create a new one. - + 2. Click **+ Add SSH key**. A popup displays. diff --git a/pages/organizations-and-projects/how-to/delete-a-project.mdx b/pages/organizations-and-projects/how-to/delete-a-project.mdx index 5d3cd10a3e..9af61e4983 100644 --- a/pages/organizations-and-projects/how-to/delete-a-project.mdx +++ b/pages/organizations-and-projects/how-to/delete-a-project.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + A Project can only be deleted once it has been emptied of its [resources](/iam/concepts/#resource). To effectively delete your Project, you must therefore **empty its resources first**. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/how-to/enforce-mfa.mdx b/pages/organizations-and-projects/how-to/enforce-mfa.mdx index 2390de6a5f..efa50c2032 100644 --- a/pages/organizations-and-projects/how-to/enforce-mfa.mdx +++ b/pages/organizations-and-projects/how-to/enforce-mfa.mdx @@ -12,10 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + [Multifactor Authentication (MFA)](/account/concepts/#multifactor-authentication-mfa) adds an extra layer of security to your Organization. Enforcing MFA will make it mandatory for all users in the Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/organizations-and-projects/how-to/manage-quotas.mdx b/pages/organizations-and-projects/how-to/manage-quotas.mdx index 93fdedf67b..17005c190c 100644 --- a/pages/organizations-and-projects/how-to/manage-quotas.mdx +++ b/pages/organizations-and-projects/how-to/manage-quotas.mdx @@ -12,8 +12,12 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/steps-to-filter-quotas.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -28,7 +32,7 @@ categories: You can also use the menu at the top of the page to search and filter your quotas. - + As shown in the image above, you can: diff --git a/pages/organizations-and-projects/quickstart.mdx b/pages/organizations-and-projects/quickstart.mdx index a299b05113..755e2fd3fc 100644 --- a/pages/organizations-and-projects/quickstart.mdx +++ b/pages/organizations-and-projects/quickstart.mdx @@ -12,6 +12,14 @@ dates: categories: - console --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-terminal-icon.webp' +import image2 from './assets/scaleway-puttygen-app.webp' +import image3 from './assets/scaleway-puttygen-01.webp' +import image4 from './assets/scaleway-puttygen-02.webp' +import image5 from './assets/scaleway-puttygen-03.webp' + When you [create a Scaleway account](/account/how-to/create-an-account/), an Organization, of which you are the [Owner](/iam/concepts/#owner), is created for you. @@ -21,7 +29,7 @@ An Organization is made of one or several [Projects](/organizations-and-projects To establish connections with Instances, Elastic Metal servers, and Mac minis, you must generate an SSH key for your Project. Creating and uploading the SSH key to your Project before resource creation has the advantage of prompting you to associate the uploaded SSH key with the resource during the creation process. This simplifies the management of SSH access for you. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -36,7 +44,7 @@ You can generate the SSH key pair on your local machine. The process will depend On macOS and Linux, you can generate the SSH key pair directly from the terminal. 1. Open the terminal application by clicking on the corresponding icon. - + 2. Type the following command and press **Enter** to generate a new key: ```bash ssh-keygen -t ed25519 -C "login@example.com" @@ -83,15 +91,15 @@ On macOS and Linux, you can generate the SSH key pair directly from the terminal On Windows, you can use the third-party application [PuTTYgen](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) to generate an SSH key pair. 1. Download and install [PuTTY](https://www.chiark.greenend.org.uk/~sgtatham/putty/latest.html) on your local computer. The **PuTTYgen** application is automatically installed along with the main PuTTY application. - + 2. Launch PuTTYgen by double-clicking the application icon. 3. Select **EdDSA** and click the **Generate** button. You can also add a passphrase before generating the key to increase security. - + 4. Move the mouse around the blank area as instructed to generate randomness. - + The public and private key are generated, and the following screen will display: - + 5. Complete the steps on the screen to finish: - Fill in the **Key comment** field with a name to help you identify this key pair. - Click the **Save public key** button and save it in the folder of your choice. diff --git a/pages/partner-space/how-to/add-client.mdx b/pages/partner-space/how-to/add-client.mdx index 2f60c24254..842272aaaa 100644 --- a/pages/partner-space/how-to/add-client.mdx +++ b/pages/partner-space/how-to/add-client.mdx @@ -12,8 +12,10 @@ dates: categories: - partner-space --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/partner-space/how-to/edit-client-information.mdx b/pages/partner-space/how-to/edit-client-information.mdx index cdaac860d9..e96b013f50 100644 --- a/pages/partner-space/how-to/edit-client-information.mdx +++ b/pages/partner-space/how-to/edit-client-information.mdx @@ -12,8 +12,10 @@ dates: categories: - partner-space --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/partner-space/how-to/grant-access-to-partner-space.mdx b/pages/partner-space/how-to/grant-access-to-partner-space.mdx index 0632e593e4..6846409001 100644 --- a/pages/partner-space/how-to/grant-access-to-partner-space.mdx +++ b/pages/partner-space/how-to/grant-access-to-partner-space.mdx @@ -12,8 +12,10 @@ dates: categories: - partner-space --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/partner-space/how-to/lock-client-organization.mdx b/pages/partner-space/how-to/lock-client-organization.mdx index e1b50e1b80..2dcdc71832 100644 --- a/pages/partner-space/how-to/lock-client-organization.mdx +++ b/pages/partner-space/how-to/lock-client-organization.mdx @@ -12,10 +12,12 @@ dates: categories: - partner-space --- +import Requirements from '@macros/iam/requirements.mdx' + If you are confronted with a client who does not respect Scaleway’s Terms of Service, you can lock their Organization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/partner-space/how-to/unlock-client-organization.mdx b/pages/partner-space/how-to/unlock-client-organization.mdx index 8da21f015b..7d30735ad0 100644 --- a/pages/partner-space/how-to/unlock-client-organization.mdx +++ b/pages/partner-space/how-to/unlock-client-organization.mdx @@ -12,8 +12,10 @@ dates: categories: - partner-space --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/partner-space/index.mdx b/pages/partner-space/index.mdx index 178abc94ea..da3d303743 100644 --- a/pages/partner-space/index.mdx +++ b/pages/partner-space/index.mdx @@ -4,7 +4,7 @@ meta: description: Dive into Scaleway Partner Space with our quickstart guide, how-tos, and more. --- - - - - - + - A Scaleway account logged in to the [console](https://console.scaleway.com) - Scaleway Partner status diff --git a/pages/public-gateways/concepts.mdx b/pages/public-gateways/concepts.mdx index be760b3692..0102cdc6d3 100644 --- a/pages/public-gateways/concepts.mdx +++ b/pages/public-gateways/concepts.mdx @@ -11,6 +11,8 @@ dates: categories: - network --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Allowed IPs @@ -116,7 +118,7 @@ Public [IP addresses](#ip-address) identify devices on the internet. You can ent ## Region and Availability Zone - + ## Routed IP diff --git a/pages/public-gateways/how-to/configure-a-public-gateway.mdx b/pages/public-gateways/how-to/configure-a-public-gateway.mdx index fb6fab3975..68cfa303c4 100644 --- a/pages/public-gateways/how-to/configure-a-public-gateway.mdx +++ b/pages/public-gateways/how-to/configure-a-public-gateway.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-nat-add-static.webp' + This page shows you how to attach a [Public Gateway](/public-gateways/concepts/#public-gateway) to a Private Network, how to configure NAT and how to enable SMTP. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -51,7 +55,7 @@ Dynamic NAT is automatically activated. However, you can review and (if you wish 2. Click the Public Gateway whose configuration you wish to modify. You are taken to the Overview page for that Public Gateway. 3. Click the **NAT** tab. 4. Use the toggle to deactivate dynamic NAT if desired. To add a new static NAT configuration for any Private Network attached to this gateway, click **Add Static NAT**. The following screen displays: - + 5. Add the following information for your new static NAT configuration: - **Protocol**: Choose TCP, UDP or Both from the drop-down menu - **Public Port**: Choose the Public Gateway port you want to use for this mapping diff --git a/pages/public-gateways/how-to/create-a-public-gateway.mdx b/pages/public-gateways/how-to/create-a-public-gateway.mdx index fbce5a4feb..72614555d2 100644 --- a/pages/public-gateways/how-to/create-a-public-gateway.mdx +++ b/pages/public-gateways/how-to/create-a-public-gateway.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import NetworkPublicGateways from '@macros/network/public-gateways.mdx' +import NetworkResourceNaming from '@macros/vpc/network-resource-naming.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +33,7 @@ categories: - Choose a **Public Gateway Type**, which impacts the pricing and bandwidth of your gateway. - Choose a public **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP. - Choose a **Name** for your Public Gateway, and, optionally, tags. - + - Verify the **Estimated Cost** of your Public Gateway, based on the specifications you chose. 4. Click **Create Public Gateway** to finish. diff --git a/pages/public-gateways/how-to/delete-a-public-gateway.mdx b/pages/public-gateways/how-to/delete-a-public-gateway.mdx index 1cb9a4705e..9aa1c274dd 100644 --- a/pages/public-gateways/how-to/delete-a-public-gateway.mdx +++ b/pages/public-gateways/how-to/delete-a-public-gateway.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-delete-gw.webp' + This page shows you how to delete a [Public Gateway](/public-gateways/concepts/#public-gateway). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -23,7 +27,7 @@ This page shows you how to delete a [Public Gateway](/public-gateways/concepts/# 1. Click **Public Gateways** in the **Network** section of the side menu. 2. Click next to the Public Gateway you wish to delete, and select **Delete** from the drop-down menu. - + If there is an associated default route in the VPC's route table, it will automatically be deleted. diff --git a/pages/public-gateways/how-to/upgrade-public-gateway.mdx b/pages/public-gateways/how-to/upgrade-public-gateway.mdx index 61a5e9047e..a763b801c9 100644 --- a/pages/public-gateways/how-to/upgrade-public-gateway.mdx +++ b/pages/public-gateways/how-to/upgrade-public-gateway.mdx @@ -12,10 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to upgrade your Public Gateway to a superior offer type, allowing you to take advantage of higher bandwidth and better performance. You can upgrade from the console in just a couple of clicks by following this procedure. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/public-gateways/how-to/use-flexible-ips.mdx b/pages/public-gateways/how-to/use-flexible-ips.mdx index 512f5a191b..5ca0749f09 100644 --- a/pages/public-gateways/how-to/use-flexible-ips.mdx +++ b/pages/public-gateways/how-to/use-flexible-ips.mdx @@ -12,6 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import FlexibleIp from '@macros/network/flexible-ip-limitations.mdx' + +import image from './assets/scaleway-attach-flexip-gw.webp' +import image2 from './assets/scaleway-attach-flexip-gw2.webp' + This page shows you how to use [flexible IP addresses](/public-gateways/concepts/#flexible-ip) with your Public Gateways. @@ -21,9 +27,9 @@ Flexible IP addresses are public IPs that you can hold independently of any Publ This how-to concerns the creation of Public Gateway flexible IPs. For the creation of [Instance flexible IPs](/instances/how-to/use-flexips/) or [Elastic Metal flexible IPs](/elastic-metal/how-to/configure-flexible-ip/), refer to the relevant documentation. Note that each set of flexible IPs is independent, and can only be used with that product. Instance flexible IPs cannot be attached to Public Gateways and vice versa. Public Gateway flexible IPs are scoped to a single Availability Zone. - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -45,9 +51,9 @@ Flexible IP addresses are public IPs that you can hold independently of any Publ 1. Click **Public Gateways** in the **Network** section of the side menu. 2. Navigate to the **Flexible IPs** tab. 3. Click next to the flexible IP that you want to attach to a Public Gateway. In the drop-down menu which opens, click **Attach**. Alternatively, click **Attach to Public Gateway** next to the flexible IP. - + 4. Select the Public Gateway that you want to attach to this flexible IP in the pop-up window, and click **Attach flexible IP**. - + Only Public Gateways that are in the same Availability Zone as your flexible IP will be selectable. diff --git a/pages/public-gateways/how-to/use-ssh-bastion.mdx b/pages/public-gateways/how-to/use-ssh-bastion.mdx index 318eb67b70..7d99d1d778 100644 --- a/pages/public-gateways/how-to/use-ssh-bastion.mdx +++ b/pages/public-gateways/how-to/use-ssh-bastion.mdx @@ -12,6 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-ssh-bastion-activate.webp' +import image2 from './assets/scaleway-activate-ssh-bastion-popup.webp' +import image3 from './assets/scaleway-ssh-bastion-allowed-ips.webp' +import image4 from './assets/scaleway-add-allowed-ips.webp' +import image5 from './assets/scaleway-ssh-bastion-reimport.webp' + SSH bastion is a server dedicated to managing connections to the infrastructure behind your Public Gateway. When you activate SSH bastion on your Public Gateway, all [SSH keys held in your Project](https://console.scaleway.com/project/ssh-keys/) are imported to the SSH bastion, providing a single point of entry. You can then connect to resources connected to the same Private Network as the Public Gateway, via the bastion. This makes management of your infrastructure easier and more secure, as you do not need to expose your other resources to the internet in order to connect to them, neither do you need to upload SSH keys to individual resources. @@ -21,7 +29,7 @@ The [Allowed IPs](#how-to-configure-allowed-ips) feature lets you control which You can also use SSH bastion to connect to resources [receiving the Public Gateway's default route advertisement](/vpc/how-to/manage-routing/#how-to-manage-default-route-scope), even if they are not attached to the same Private Network as the gateway. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -32,9 +40,9 @@ You can also use SSH bastion to connect to resources [receiving the Public Gatew 1. Click **Public Gateways** in the **Network** section of the Scaleway console side menu. 2. Click the Public Gateway for which you want to activate SSH bastion. You are taken to the **Overview** page for that Public Gateway. - + 3. Under **SSH Bastion**, click **Enable SSH bastion** to activate the feature. A pop-up displays: - + 4. Enter the port that you want your SSH bastion to listen on (or leave the default port in place). The default port is 61000 (ours), to avoid conflicts. When setting your own port, you must choose a port number between 1024 and 59999. The port that the SSH bastion listens on must not be a port already in use by a [NAT rule](/public-gateways/concepts/#nat). @@ -53,7 +61,7 @@ The [Allowed IPs](#how-to-configure-allowed-ips) feature lets you control which When you first activate SSH bastion, the Allowed IPs list has one entry: a default IP range of `0.0.0.0/0` which gives access to **all** public IPs. - + ### How to allow all IPs @@ -72,7 +80,7 @@ To restrict connections to resources behind the bastion to specific public IPs o The IP range is deleted and you are returned to the Allowed IPs list. 4. Click the **+ Add allowed IPs** button. A pop-up displays, asking you to enter the IPv4 address ranges to allow. - + 5. Enter the IPv4 address ranges you to want to allow to connect to your SSH bastion. In each case, include the subnet mask (use `/32` for single addresses). You can add multiple IP ranges in one go by separating them with new lines. 6. Click the **Add IPs** button. The IPs are added, and you are returned to the Allowed IPs list. @@ -88,7 +96,7 @@ If you add new SSH keys to your [Project](/organizations-and-projects/concepts/# 1. Click **Public Gateways** in the **Network** section of the Scaleway console side menu. 2. Click the Public Gateway for which you want to update the SSH bastion. You are taken to the **Overview** page for that Public Gateway. 3. Under **SSH Bastion** click the **Reimport list** button. - + Your SSH bastion is updated with the new SSH keys. diff --git a/pages/public-gateways/index.mdx b/pages/public-gateways/index.mdx index 12c1dc9036..98f3ea88e2 100644 --- a/pages/public-gateways/index.mdx +++ b/pages/public-gateways/index.mdx @@ -49,17 +49,17 @@ meta: ## Tutorials - - - \ No newline at end of file +/> diff --git a/pages/public-gateways/quickstart.mdx b/pages/public-gateways/quickstart.mdx index eb3ba55bd2..fe0aaca24c 100644 --- a/pages/public-gateways/quickstart.mdx +++ b/pages/public-gateways/quickstart.mdx @@ -12,10 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import NetworkPublicGateways from '@macros/network/public-gateways.mdx' +import NetworkResourceNaming from '@macros/vpc/network-resource-naming.mdx' - - + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - Created a [Private Network](/vpc/how-to/create-private-network/) @@ -29,7 +33,7 @@ categories: - Choose a **Public Gateway Type**, which impacts the pricing and bandwidth of your gateway. - Choose a public **IP**. You can choose to assign one of your existing flexible IPs to your Public Gateway, or create and assign a new public IP. - Choose a **Name** for your Public Gateway, and, optionally, tags. - + - Verify the **Estimated Cost** of your Public Gateway, based on the specifications you chose. 4. Click **Create Public Gateway** to finish. diff --git a/pages/public-gateways/reference-content/understanding-v2.mdx b/pages/public-gateways/reference-content/understanding-v2.mdx index c9127230e8..5f1f703d12 100644 --- a/pages/public-gateways/reference-content/understanding-v2.mdx +++ b/pages/public-gateways/reference-content/understanding-v2.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import image from './assets/scaleway-pgw-listing.webp' + Scaleway's VPC offering is evolving, and with this comes changes for the Public Gateway product. @@ -80,7 +82,7 @@ Scaleway Public Gateways are either in **Legacy mode** or **IPAM mode**. You can - Checking its badge in the gateway listing page of the [Scaleway console](https://console.scaleway.com/public-gateway/public-gateways) (see screenshot below). - Checking the value of the `is_legacy` field via the [Public Gateways API](https://www.scaleway.com/en/developers/api/public-gateway/#path-gateways-get-a-public-gateway). - + All Public Gateways created via the Scaleway console since 17 October 2023 are necessarily in IPAM mode. diff --git a/pages/public-gateways/troubleshooting/gateway-services-not-working.mdx b/pages/public-gateways/troubleshooting/gateway-services-not-working.mdx index 1a4dd35c40..a83e12db5f 100644 --- a/pages/public-gateways/troubleshooting/gateway-services-not-working.mdx +++ b/pages/public-gateways/troubleshooting/gateway-services-not-working.mdx @@ -12,8 +12,10 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/public-gateways/troubleshooting/index.mdx b/pages/public-gateways/troubleshooting/index.mdx index 96c5691e5d..f8debb0ca5 100644 --- a/pages/public-gateways/troubleshooting/index.mdx +++ b/pages/public-gateways/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: PublicGatewayProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/queues/api-cli/python-node-queues.mdx b/pages/queues/api-cli/python-node-queues.mdx index 31c3090624..19faa29d64 100644 --- a/pages/queues/api-cli/python-node-queues.mdx +++ b/pages/queues/api-cli/python-node-queues.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-14 posted: 2023-01-04 --- +import Requirements from '@macros/iam/requirements.mdx' + AWS provides a number of SDKs (**S**oftware **D**evelopment **K**its) which provide language-specific APIs for AWS services, including [SQS](/queues/concepts#sqs), which is the protocol Scaleway Queues is based on. @@ -22,7 +24,7 @@ AWS provides a number of SDKs (**S**oftware **D**evelopment **K**its) which prov This guide provides code samples to show you how to start using these SDKs with Scaleway Queues. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/queues/api-cli/queues-aws-cli.mdx b/pages/queues/api-cli/queues-aws-cli.mdx index 1f83ac3480..7fffbc25d7 100644 --- a/pages/queues/api-cli/queues-aws-cli.mdx +++ b/pages/queues/api-cli/queues-aws-cli.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-04-02 posted: 2025-04-02 --- +import Requirements from '@macros/iam/requirements.mdx' + The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. Once you have [connected Scaleway Queues to the AWS-CLI](/queues/api-cli/connect-aws-cli/), you can start creating, listing and managing your queues, sending messages and much more, all from your command line. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/queues/how-to/create-credentials.mdx b/pages/queues/how-to/create-credentials.mdx index 9a029f33f0..04e4abae54 100644 --- a/pages/queues/how-to/create-credentials.mdx +++ b/pages/queues/how-to/create-credentials.mdx @@ -13,12 +13,16 @@ dates: validation: 2025-04-02 posted: 2025-04-02 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-queues-gen-creds.webp' + This page shows how to create [credentials](/queues/concepts/#credentials) for Scaleway Queues. Credentials give their bearer (e.g. services and platforms) access to your messaging queue service. You can create multiple sets of credentials for Scaleway Queues. Credentials for Queues are granular: you can define the level of access that they should give. Credentials give the specified level of access to all queues that you create in the [region](/queues/concepts/#region) they are scoped to. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +33,7 @@ You can create multiple sets of credentials for Scaleway Queues. Credentials for 3. Click **Generate credentials**. A pop-up displays: - + 4. Choose a region that these credentials should be scoped to. diff --git a/pages/queues/how-to/create-manage-queues.mdx b/pages/queues/how-to/create-manage-queues.mdx index bf13839b0c..e664591cf8 100644 --- a/pages/queues/how-to/create-manage-queues.mdx +++ b/pages/queues/how-to/create-manage-queues.mdx @@ -13,10 +13,15 @@ dates: validation: 2025-04-02 posted: 2022-08-11 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-queues-create-queue.webp' +import image2 from './assets/scaleway-queues-queue-settings.webp' + This page shows how to create and manage your queues with [Scaleway Queues](/queues/concepts/#queue) (formerly part of the **Messaging and Queuing** product). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -27,7 +32,7 @@ This page shows how to create and manage your queues with [Scaleway Queues](/que 2. Click **Create queue**. The queue creation wizard displays. - + 3. Select the [region](/queues/concepts/#region) in which you want to create the queue. @@ -64,7 +69,7 @@ You can modify the visibility timeout, message retention period and maximum mess 3. Click the queue you wish to modify. The queue's **Settings** page displays: - + 4. Modify the visibility timeout, message retention period, maximum message size, dead-letter queue settings, and (for FIFO queues) content-based deduplication values as you wish. diff --git a/pages/queues/how-to/manage-credentials.mdx b/pages/queues/how-to/manage-credentials.mdx index 282e88d293..a9ee7b6e5b 100644 --- a/pages/queues/how-to/manage-credentials.mdx +++ b/pages/queues/how-to/manage-credentials.mdx @@ -13,12 +13,16 @@ categories: - serverless - queues --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-queues-update-creds.webp' + Credentials give their bearer (e.g. services and platforms) access to your Queues service. This page shows how to manage [credentials](/queues/concepts/#credentials) for Scaleway Queues. Credentials can be updated to change their permissions, or revoked entirely. Once credentials are revoked, any user trying to use the credentials to connect to the service will be denied. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -34,7 +38,7 @@ This page shows how to manage [credentials](/queues/concepts/#credentials) for S 4. Click the button next to the credentials you want to update, and select **Update credentials**. A pop-up displays, such as the one below for Queues: - + 5. Make the required updates to your credentials. You can modify the name, and the permissions. diff --git a/pages/queues/how-to/monitor-queues-cockpit.mdx b/pages/queues/how-to/monitor-queues-cockpit.mdx index 09110d5158..a8fec3476d 100644 --- a/pages/queues/how-to/monitor-queues-cockpit.mdx +++ b/pages/queues/how-to/monitor-queues-cockpit.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-03 posted: 2025-04-03 --- +import Requirements from '@macros/iam/requirements.mdx' + You can view metrics for your Queues services via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your queues and messages at a glance. There are two steps to complete to view your metrics for the first time with Cockpit: @@ -21,7 +23,7 @@ You can view metrics for your Queues services via [Scaleway Cockpit](/cockpit/qu These steps are described below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/queues/index.mdx b/pages/queues/index.mdx index e33c4d05ff..614d4165d9 100644 --- a/pages/queues/index.mdx +++ b/pages/queues/index.mdx @@ -4,7 +4,7 @@ meta: description: Explore Scaleway Queues. Simplify your microservice workflows with scalable, reliable, and cost-effective message handling solutions. --- - - \ No newline at end of file +/> diff --git a/pages/queues/quickstart.mdx b/pages/queues/quickstart.mdx index 1103f25ecc..7c5f49c01d 100644 --- a/pages/queues/quickstart.mdx +++ b/pages/queues/quickstart.mdx @@ -13,9 +13,14 @@ categories: - serverless - queues --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-queues-gen-creds.webp' +import image2 from './assets/scaleway-queues-create-queue.webp' + Scaleway Queues is a managed message broker service that allows you to transfer messages between different microservices and platforms via queues. This enables decoupled applications to "talk" to each other effectively even if they are not otherwise compatible. Scaleway Queues enables and simplifies microservices application development and allows you to build highly scalable, reliable, distributed applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -30,7 +35,7 @@ Credentials for Queues are granular: you can define the level of access that the 3. Click **Generate credentials**. A pop-up displays: - + 4. Choose a region that these credentials should be scoped to. @@ -56,7 +61,7 @@ Credentials for Queues are granular: you can define the level of access that the 2. Click **Create queue**. The queue creation wizard displays. - + 3. Select the [region](/queues/concepts/#region) in which you want to create the queue. diff --git a/pages/queues/troubleshooting/index.mdx b/pages/queues/troubleshooting/index.mdx index 599e907188..e08f395799 100644 --- a/pages/queues/troubleshooting/index.mdx +++ b/pages/queues/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: QueueingProductIcon ## Featured Pages - - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/scaleway-cli/reference-content/environment-variables.mdx b/pages/scaleway-cli/reference-content/environment-variables.mdx index c0ef0628b1..be560c5c7b 100644 --- a/pages/scaleway-cli/reference-content/environment-variables.mdx +++ b/pages/scaleway-cli/reference-content/environment-variables.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayEnvironmentVariables from '@macros/developer-tools/scaleway-environment-variables.mdx' - + + diff --git a/pages/scaleway-cli/reference-content/scaleway-configuration-file.mdx b/pages/scaleway-cli/reference-content/scaleway-configuration-file.mdx index 0bf7124cf4..4924572dcf 100644 --- a/pages/scaleway-cli/reference-content/scaleway-configuration-file.mdx +++ b/pages/scaleway-cli/reference-content/scaleway-configuration-file.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayConfigurationFile from '@macros/developer-tools/scaleway-configuration-file.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/scaleway-sdk/reference-content/environment-variables.mdx b/pages/scaleway-sdk/reference-content/environment-variables.mdx index 8f71d6efc0..f3cba98add 100644 --- a/pages/scaleway-sdk/reference-content/environment-variables.mdx +++ b/pages/scaleway-sdk/reference-content/environment-variables.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayEnvironmentVariables from '@macros/developer-tools/scaleway-environment-variables.mdx' - + + diff --git a/pages/scaleway-sdk/reference-content/scaleway-configuration-file.mdx b/pages/scaleway-sdk/reference-content/scaleway-configuration-file.mdx index 9f24f02ac4..f4b6c20eb9 100644 --- a/pages/scaleway-sdk/reference-content/scaleway-configuration-file.mdx +++ b/pages/scaleway-sdk/reference-content/scaleway-configuration-file.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayConfigurationFile from '@macros/developer-tools/scaleway-configuration-file.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/secret-manager/api-cli/create-secret-with-type.mdx b/pages/secret-manager/api-cli/create-secret-with-type.mdx index e1e29b9daf..54a88de0b5 100644 --- a/pages/secret-manager/api-cli/create-secret-with-type.mdx +++ b/pages/secret-manager/api-cli/create-secret-with-type.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-03-03 posted: 2024-04-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This documentation shows you how to create a `database credentials` secret type, with a version matching this type, using the [Secret Manager API](https://www.scaleway.com/en/developers/api/secret-manager/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/api-cli/external-secrets.mdx b/pages/secret-manager/api-cli/external-secrets.mdx index 177a12918a..b056f7bbf0 100644 --- a/pages/secret-manager/api-cli/external-secrets.mdx +++ b/pages/secret-manager/api-cli/external-secrets.mdx @@ -11,6 +11,8 @@ dates: validation: 2025-06-03 posted: 2023-02-21 --- +import Requirements from '@macros/iam/requirements.mdx' + ## External Secrets - Overview @@ -18,7 +20,7 @@ dates: In this tutorial you will learn how to deploy External Secrets and its services on [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule), the managed Kubernetes service from Scaleway. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/concepts.mdx b/pages/secret-manager/concepts.mdx index 8c9710f64c..ecacbb9295 100644 --- a/pages/secret-manager/concepts.mdx +++ b/pages/secret-manager/concepts.mdx @@ -9,6 +9,8 @@ tags: secret-manager secret version dates: validation: 2025-04-15 --- +import image from './assets/scaleway-secret-manager-schema.webp' + ## Disabling a version @@ -79,7 +81,7 @@ With Secret Manager, you can also share sensitive data such as passwords, API ke Scaleway's Secret Manager can be managed using [APIs](https://www.scaleway.com/en/developers/api/secret-manager/) and the Scaleway [CLI](https://www.scaleway.com/en/cli/), which allow authorized applications or services to retrieve secrets securely. This enables you to automate a deployment by fetching your passwords stored on Secret Manager through the API, and storing them in your environment variables, which will then be used by your application. - + ## Secret protection diff --git a/pages/secret-manager/how-to/create-secret.mdx b/pages/secret-manager/how-to/create-secret.mdx index 58adc0696d..e08bbbd000 100644 --- a/pages/secret-manager/how-to/create-secret.mdx +++ b/pages/secret-manager/how-to/create-secret.mdx @@ -12,12 +12,14 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + The [secret](/secret-manager/concepts/#secret) creation process slightly differs depending on whether you are using Secret Manager for the first time or not. Upon secret creation, you are prompted to choose a Scaleway-managed encryption key or specify an existing [Key Manager](/key-manager) key which will encrypt your data. This allows for secure and flexible encryption of your data, compliant with industry standards. This page explains how to create a [secret](/secret-manager/concepts/#secret) for the first time using the [Scaleway console](https://console.scaleway.com) and how to create a secret if you have already created resources in Secret Manager. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/create-version.mdx b/pages/secret-manager/how-to/create-version.mdx index 54342ab5b7..1b400f1b70 100644 --- a/pages/secret-manager/how-to/create-version.mdx +++ b/pages/secret-manager/how-to/create-version.mdx @@ -12,12 +12,14 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + When creating a secret, its value is stored in its first version, which is [enabled](/secret-manager/concepts/#enabling-a-version) by default. At creation, your secret only has one version. This page explains how to add more [versions](/secret-manager/concepts/#version) to a secret using the [Scaleway console](https://console.scaleway.com). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/delete-secret.mdx b/pages/secret-manager/how-to/delete-secret.mdx index 3d41f519f3..2df0fb80f2 100644 --- a/pages/secret-manager/how-to/delete-secret.mdx +++ b/pages/secret-manager/how-to/delete-secret.mdx @@ -12,12 +12,14 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to [schedule a secret deletion](/secret-manager/concepts/#scheduled-deletion) using the [Scaleway console](https://console.scaleway.com). You **cannot delete protected secrets**, i.e. secrets to which you have applied [secret protection](/secret-manager/concepts/#secret-protection). Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-secrets/). After this retention period, the secret and all its versions are permanently deleted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/delete-version.mdx b/pages/secret-manager/how-to/delete-version.mdx index a4de62e080..0667b72629 100644 --- a/pages/secret-manager/how-to/delete-version.mdx +++ b/pages/secret-manager/how-to/delete-version.mdx @@ -12,12 +12,14 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to [schedule](/secret-manager/concepts/#scheduled-deletion) a [version](/secret-manager/concepts/#version) deletion using the [Scaleway console](https://console.scaleway.com). Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still [recover it](/secret-manager/how-to/recover-version/). After this retention period, the version is permanently deleted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/filter-secrets.mdx b/pages/secret-manager/how-to/filter-secrets.mdx index 5e2be6abc6..753a69ab60 100644 --- a/pages/secret-manager/how-to/filter-secrets.mdx +++ b/pages/secret-manager/how-to/filter-secrets.mdx @@ -12,6 +12,8 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to filter Secret Manager secrets by name, [type](/secret-manager/concepts/#secret-types), and tags. @@ -21,7 +23,7 @@ Filtering secrets by [type](/secret-manager/concepts/#secret-types) allows you t Filtering by tags allows you to categorize your secrets with more flexibility. Unlike rigid hierarchical structures, tags can be applied dynamically to group secrets based on various criteria. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/manage-secret.mdx b/pages/secret-manager/how-to/manage-secret.mdx index ebaf764dff..b1a9d663c1 100644 --- a/pages/secret-manager/how-to/manage-secret.mdx +++ b/pages/secret-manager/how-to/manage-secret.mdx @@ -12,12 +12,14 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + The process of managing a secret might differ depending on whether your secret is [ephemeral](/secret-manager/concepts/#ephemeral-secret) or not. Find out how to copy the ID of your [secret](/secret-manager/concepts/#secret), how to update its description and tags, how to enable [secret protection](/secret-manager/concepts/#secret-protection) on it, and how to update its [ephemeral policy](/secret-manager/concepts/#ephemeral-policy) using the [Scaleway console](https://console.scaleway.com). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/manage-version.mdx b/pages/secret-manager/how-to/manage-version.mdx index f905aaa8ad..196ab71cc2 100644 --- a/pages/secret-manager/how-to/manage-version.mdx +++ b/pages/secret-manager/how-to/manage-version.mdx @@ -12,10 +12,12 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to manage a secret [version](/secret-manager/concepts/#version) using the [Scaleway console](https://console.scaleway.com). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/recover-secrets.mdx b/pages/secret-manager/how-to/recover-secrets.mdx index f0c7a339ad..914c03dea3 100644 --- a/pages/secret-manager/how-to/recover-secrets.mdx +++ b/pages/secret-manager/how-to/recover-secrets.mdx @@ -12,6 +12,8 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to recover secrets scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a secret for deletion, it enters a 7-day pending deletion period, during which you can still recover it. After this retention period, the secret and all its versions are permanently deleted. @@ -20,7 +22,7 @@ After this retention period, the secret and all its versions are permanently del Scheduled deletion deletes ephemeral secrets and their versions immediately. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/how-to/recover-version.mdx b/pages/secret-manager/how-to/recover-version.mdx index ec2dfd5a33..5b82691154 100644 --- a/pages/secret-manager/how-to/recover-version.mdx +++ b/pages/secret-manager/how-to/recover-version.mdx @@ -12,6 +12,8 @@ dates: categories: - identity-and-access-management --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to recover a version scheduled for deletion using the Scaleway [console](https://console.scaleway.com). Once you schedule a version for deletion, it enters a 7-day pending deletion period, during which you can still recover it. After this retention period, the version is permanently deleted. @@ -20,7 +22,7 @@ After this retention period, the version is permanently deleted. Scheduled deletion deletes ephemeral secrets and their versions immediately. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/secret-manager/index.mdx b/pages/secret-manager/index.mdx index 47b4f01711..f033560123 100644 --- a/pages/secret-manager/index.mdx +++ b/pages/secret-manager/index.mdx @@ -48,12 +48,12 @@ meta: ## API/CLI - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/api-cli/deploy-container-api.mdx b/pages/serverless-containers/api-cli/deploy-container-api.mdx index 3b8b3429af..72acc9f549 100644 --- a/pages/serverless-containers/api-cli/deploy-container-api.mdx +++ b/pages/serverless-containers/api-cli/deploy-container-api.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + The Scaleway API allows you to create and manage all your Scaleway resources programmatically. Anything you can do through the [Scaleway console](https://www.console.scaleway.com) can also be done through the API. Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developers/api/) for more information on the Scaleway API. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/api-cli/deploy-container-cli.mdx b/pages/serverless-containers/api-cli/deploy-container-cli.mdx index 475f47c137..37c1f271c8 100644 --- a/pages/serverless-containers/api-cli/deploy-container-cli.mdx +++ b/pages/serverless-containers/api-cli/deploy-container-cli.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + ## Scaleway Command Line Interface Overview [The Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. The Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and deploy Serverless Containers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry.mdx b/pages/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry.mdx index b4f1150640..33227eda3f 100644 --- a/pages/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry.mdx +++ b/pages/serverless-containers/api-cli/migrate-external-image-to-scaleway-registry.mdx @@ -12,14 +12,17 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + Serverless Containers rely on images that can be stored in the Scaleway Container Registry, or in external public registries. - + This page explains how to migrate images from public external container registries (such as Docker Hub, Amazon container registries, GitHub Container Registry, etc.) to the [Scaleway Container registry](/container-registry/concepts/#container-registry). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/faq.mdx b/pages/serverless-containers/faq.mdx index f01be86b98..2d1af8faf8 100644 --- a/pages/serverless-containers/faq.mdx +++ b/pages/serverless-containers/faq.mdx @@ -9,6 +9,8 @@ dates: category: serverless productIcon: ContainersProductIcon --- +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + ## Overview @@ -177,7 +179,7 @@ Integration is straightforward. Serverless Functions and Containers can be trigg ### Where should I host my container images for deployment ? - + ### How can I copy an image from an external registry to Scaleway Container Registry? diff --git a/pages/serverless-containers/how-to/add-a-custom-domain-to-a-container.mdx b/pages/serverless-containers/how-to/add-a-custom-domain-to-a-container.mdx index 2b4e050277..29a807f3cc 100644 --- a/pages/serverless-containers/how-to/add-a-custom-domain-to-a-container.mdx +++ b/pages/serverless-containers/how-to/add-a-custom-domain-to-a-container.mdx @@ -13,10 +13,15 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/cloudflare-root-domain-configuration.webp' +import image2 from './assets/cloudflare-bypass-cache-well-known-acme-challenge.webp' + Each container comes with an automatically generated domain, on which it is available. However, it is possible to use your own domain name to address your containers to facilitate their use. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -30,7 +35,7 @@ Each container comes with an automatically generated domain, on which it is avai - When using a root domain: - If available, CNAME flattening is **mandatory**. [CNAME flattening](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/) speeds up CNAME resolution and allows you to use a CNAME record at your root/apex domain. For example, for Cloudflare, this will look like the following: - + - If your DNS provider does not support CNAME flattening, you need to create an ALIAS on your root domain (named `@` or with an empty name) instead of a CNAME. @@ -87,7 +92,7 @@ HTTP-01 challenge failure (and by extension, a custom domain in `error` status) Example of configuration on Cloudflare to disable caching with "Cache rules": - + ## Migrating an active domain diff --git a/pages/serverless-containers/how-to/add-trigger-to-a-container.mdx b/pages/serverless-containers/how-to/add-trigger-to-a-container.mdx index a20383806a..547af77aec 100644 --- a/pages/serverless-containers/how-to/add-trigger-to-a-container.mdx +++ b/pages/serverless-containers/how-to/add-trigger-to-a-container.mdx @@ -13,6 +13,8 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure triggers for your Serverless Containers. A trigger is an event that invokes a container. @@ -20,7 +22,7 @@ In a serverless architecture, a container is not running constantly, but is rath A trigger can be an HTTP request, a message from a queue or stream, a CRON schedule etc. It is configured during the container deployment, and determines how and when the container will run. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/build-push-container-image.mdx b/pages/serverless-containers/how-to/build-push-container-image.mdx index bbd23c2ad1..5983f548e1 100644 --- a/pages/serverless-containers/how-to/build-push-container-image.mdx +++ b/pages/serverless-containers/how-to/build-push-container-image.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to create a simple Dockerfile to containerize your applications for deployment using Scaleway Serverless Containers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/configure-alerts-containers.mdx b/pages/serverless-containers/how-to/configure-alerts-containers.mdx index 3d887a74fd..6967dd06a8 100644 --- a/pages/serverless-containers/how-to/configure-alerts-containers.mdx +++ b/pages/serverless-containers/how-to/configure-alerts-containers.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure alerts for Scaleway Serverless Containers using Scaleway Cockpit and Grafana. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/create-auth-token-from-console.mdx b/pages/serverless-containers/how-to/create-auth-token-from-console.mdx index 474a7e7097..0208899ee3 100644 --- a/pages/serverless-containers/how-to/create-auth-token-from-console.mdx +++ b/pages/serverless-containers/how-to/create-auth-token-from-console.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create and manage an authentication token from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/create-manage-delete-containers-namespace.mdx b/pages/serverless-containers/how-to/create-manage-delete-containers-namespace.mdx index f74595ea2a..e59792ab39 100644 --- a/pages/serverless-containers/how-to/create-manage-delete-containers-namespace.mdx +++ b/pages/serverless-containers/how-to/create-manage-delete-containers-namespace.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create and manage a Serverless Containers namespace. [Namespaces](/serverless-containers/concepts/#namespace) allow you to group your containers and share environment variables between them. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/delete-a-container.mdx b/pages/serverless-containers/how-to/delete-a-container.mdx index e8d7578d3b..63460406c6 100644 --- a/pages/serverless-containers/how-to/delete-a-container.mdx +++ b/pages/serverless-containers/how-to/delete-a-container.mdx @@ -13,6 +13,8 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a Scaleway container. @@ -20,7 +22,7 @@ This page shows you how to delete a Scaleway container. This action is irreversible and permanently deletes your container and all its data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/deploy-container.mdx b/pages/serverless-containers/how-to/deploy-container.mdx index 478c950f6f..e24dd9ace5 100644 --- a/pages/serverless-containers/how-to/deploy-container.mdx +++ b/pages/serverless-containers/how-to/deploy-container.mdx @@ -13,12 +13,15 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + This page shows you how to deploy Serverless Containers using the [Scaleway console](https://console.scaleway.com/). You can deploy a container from the [Scaleway Container Registry](/container-registry/quickstart/), or any other public container registry, such as Docker Hub, AWS Container registries, GitLab container registry, etc. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -104,7 +107,7 @@ Scaleway Serverless Containers allows you to deploy containers from external pub Private external container registries are currently not supported. - + 1. Click **Containers** in the **Serverless** section of the side menu. The containers page displays. diff --git a/pages/serverless-containers/how-to/manage-a-container.mdx b/pages/serverless-containers/how-to/manage-a-container.mdx index 9007471184..a818040ce8 100644 --- a/pages/serverless-containers/how-to/manage-a-container.mdx +++ b/pages/serverless-containers/how-to/manage-a-container.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to manage a container, in order to verify or edit its deployment parameters after creation. You can deploy a container from the [Scaleway Container Registry](/container-registry/quickstart/) or any other public container registry, such as Docker Hub, AWS Container registries, GitLab container registry, etc. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/modify-container-privacy.mdx b/pages/serverless-containers/how-to/modify-container-privacy.mdx index 32e3dcbf65..cd2004e0aa 100644 --- a/pages/serverless-containers/how-to/modify-container-privacy.mdx +++ b/pages/serverless-containers/how-to/modify-container-privacy.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to modify a container's [privacy policy](/serverless-containers/concepts/#privacy-policy), after its creation. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/monitor-container.mdx b/pages/serverless-containers/how-to/monitor-container.mdx index 6a5519f163..cbd1481b7f 100644 --- a/pages/serverless-containers/how-to/monitor-container.mdx +++ b/pages/serverless-containers/how-to/monitor-container.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Serverless Containers is fully integrated into [Cockpit](/cockpit/quickstart/), and allows you to quickly access your logs and metrics. This page explains how to get started with Scaleway Cockpit to monitor your Serverless Containers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/secure-a-container.mdx b/pages/serverless-containers/how-to/secure-a-container.mdx index 55eb3ab732..c5819101cb 100644 --- a/pages/serverless-containers/how-to/secure-a-container.mdx +++ b/pages/serverless-containers/how-to/secure-a-container.mdx @@ -13,10 +13,12 @@ categories: - serverless - containers --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to secure your container. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/test-a-container.mdx b/pages/serverless-containers/how-to/test-a-container.mdx index 6796d2d156..5eef6dcda3 100644 --- a/pages/serverless-containers/how-to/test-a-container.mdx +++ b/pages/serverless-containers/how-to/test-a-container.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to execute Serverless Containers from the [Scaleway console](https://console.scaleway.com). The **Test** feature of a container allows you to run your code using a selection of methods to make sure it behaves as expected. @@ -19,7 +21,7 @@ This page shows you how to execute Serverless Containers from the [Scaleway cons Testing **Private** Serverless Functions is not possible using the Scaleway console due to CORS limitations. Refer to the [dedicated documentation](/serverless-containers/how-to/create-auth-token-from-console/) for more information on how to secure and test a private function. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/how-to/use-private-networks.mdx b/pages/serverless-containers/how-to/use-private-networks.mdx index e3748e8dd1..e0c1bd32ee 100644 --- a/pages/serverless-containers/how-to/use-private-networks.mdx +++ b/pages/serverless-containers/how-to/use-private-networks.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/serverless-containers/concepts/#private-networks) allow your Serverless Containers to communicate in an isolated and secure network without needing to be connected to the public internet. Each container can be connected to one or several Private Networks, letting you build your own network topologies. @@ -21,7 +23,7 @@ For full information about Scaleway Private Networks and VPC, see our [dedicated The Private Networks feature can only be enabled on newly created namespaces. Existing namespaces that do not have the feature enabled cannot be integrated in a Private Network. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-containers/index.mdx b/pages/serverless-containers/index.mdx index e9f78caff9..5423146c73 100644 --- a/pages/serverless-containers/index.mdx +++ b/pages/serverless-containers/index.mdx @@ -4,7 +4,7 @@ meta: description: Introduction to Scaleway Serverless Containers. --- - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -79,7 +82,7 @@ If you have no existing Serverless Containers resources in your current Project, If you have no existing Serverless Containers resources in your current Project, the creation process will guide you through the creation of a namespace, and then a container. - + 1. Click **Containers** in the **Serverless** section of the side menu. The containers page displays. diff --git a/pages/serverless-containers/reference-content/cron-schedules.mdx b/pages/serverless-containers/reference-content/cron-schedules.mdx index a339c47178..8c8b33e8d0 100644 --- a/pages/serverless-containers/reference-content/cron-schedules.mdx +++ b/pages/serverless-containers/reference-content/cron-schedules.mdx @@ -13,5 +13,7 @@ categories: - serverless - containers --- +import CronSchedules from '@macros/serverless/cron-schedules.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-containers/reference-content/difference-jobs-functions-containers.mdx b/pages/serverless-containers/reference-content/difference-jobs-functions-containers.mdx index dfb342c7dc..118b1a4ef0 100644 --- a/pages/serverless-containers/reference-content/difference-jobs-functions-containers.mdx +++ b/pages/serverless-containers/reference-content/difference-jobs-functions-containers.mdx @@ -13,5 +13,7 @@ categories: - serverless - containers --- +import DifferenceJobsFunctionsContainers from '@macros/serverless/difference-jobs-functions-containers.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-containers/reference-content/dns-query-rate-limit.mdx b/pages/serverless-containers/reference-content/dns-query-rate-limit.mdx index cc2735f175..5637403504 100644 --- a/pages/serverless-containers/reference-content/dns-query-rate-limit.mdx +++ b/pages/serverless-containers/reference-content/dns-query-rate-limit.mdx @@ -13,5 +13,7 @@ categories: - serverless - containers --- +import DnsQueryRateLimit from '@macros/serverless/dns-query-rate-limit.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-containers/troubleshooting/index.mdx b/pages/serverless-containers/troubleshooting/index.mdx index c112cd4cce..c1ae47729c 100644 --- a/pages/serverless-containers/troubleshooting/index.mdx +++ b/pages/serverless-containers/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: ContainersProductIcon ## Featured Pages - - - - - - + + diff --git a/pages/serverless-functions/api-cli/deploy-function-api.mdx b/pages/serverless-functions/api-cli/deploy-function-api.mdx index 87351551e2..acb0d116dc 100644 --- a/pages/serverless-functions/api-cli/deploy-function-api.mdx +++ b/pages/serverless-functions/api-cli/deploy-function-api.mdx @@ -12,13 +12,15 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + The Scaleway API allows you to create and manage all your Scaleway resources programmatically. Anything you can do through the [Scaleway console](https://www.console.scaleway.com) can also be done through the API. Refer to the [Scaleway Developers website](https://www.scaleway.com/en/developers/api/) for more information on the Scaleway API. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/api-cli/deploy-function-cli.mdx b/pages/serverless-functions/api-cli/deploy-function-cli.mdx index 246c9f3123..037fc0b6c7 100644 --- a/pages/serverless-functions/api-cli/deploy-function-cli.mdx +++ b/pages/serverless-functions/api-cli/deploy-function-cli.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + ## Scaleway Command Line Interface Overview [The Scaleway Command Line Interface (CLI)](https://github.com/scaleway/scaleway-cli) allows you to pilot your Scaleway infrastructure directly from your terminal, providing a faster way to administer and monitor your resources. Scaleway CLI is easy to set up and use, and an essential tool for operating efficiently in your cloud environment. The CLI provides many functionalities, including the ability to create and deploy Serverless Functions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/add-a-custom-domain-name-to-a-function.mdx b/pages/serverless-functions/how-to/add-a-custom-domain-name-to-a-function.mdx index 66545df343..20df658235 100644 --- a/pages/serverless-functions/how-to/add-a-custom-domain-name-to-a-function.mdx +++ b/pages/serverless-functions/how-to/add-a-custom-domain-name-to-a-function.mdx @@ -12,10 +12,15 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/cloudflare-root-domain-configuration.webp' +import image2 from './assets/cloudflare-bypass-cache-well-known-acme-challenge.webp' + Each function comes with an automatically generated domain, on which it is available. However, it is possible to use your own domain name to address your function to facilitate their use. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +36,7 @@ Each function comes with an automatically generated domain, on which it is avail - When using a root domain: - If available, CNAME flattening is **mandatory**. [CNAME flattening](https://blog.cloudflare.com/introducing-cname-flattening-rfc-compliant-cnames-at-a-domains-root/) speeds up CNAME resolution and allows you to use a CNAME record at your root/apex domain. For example, for Cloudflare, this will look like the following: - + - If your DNS provider does not support CNAME flattening, you need to create an ALIAS on your root domain (named `@` or with an empty name) instead of a CNAME. @@ -84,7 +89,7 @@ HTTP-01 challenge failure (and by extension, a custom domain in `error` status) Example of configuration on Cloudflare to disable caching with "Cache rules": - + ## Migrating an active domain diff --git a/pages/serverless-functions/how-to/add-trigger-to-a-function.mdx b/pages/serverless-functions/how-to/add-trigger-to-a-function.mdx index 3233aa8e41..9ff4501507 100644 --- a/pages/serverless-functions/how-to/add-trigger-to-a-function.mdx +++ b/pages/serverless-functions/how-to/add-trigger-to-a-function.mdx @@ -13,6 +13,8 @@ categories: - serverless - functions --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure triggers for your Serverless Functions. A trigger is an event that invokes a function. @@ -20,7 +22,7 @@ In a serverless architecture, a function only runs when it is called by an event A trigger can be an HTTP request, a message from a queue or stream, a CRON schedule etc. It is configured during the function deployment, and determines how and when the function will run. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/configure-alerts-functions.mdx b/pages/serverless-functions/how-to/configure-alerts-functions.mdx index 0a636eff19..263dea7aea 100644 --- a/pages/serverless-functions/how-to/configure-alerts-functions.mdx +++ b/pages/serverless-functions/how-to/configure-alerts-functions.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure alerts for Scaleway Serverless Functions using Scaleway Cockpit and Grafana. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/create-a-function.mdx b/pages/serverless-functions/how-to/create-a-function.mdx index 9b8ab7b098..29075cd1a3 100644 --- a/pages/serverless-functions/how-to/create-a-function.mdx +++ b/pages/serverless-functions/how-to/create-a-function.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to deploy a [function](/serverless-functions/concepts/#serverless-functions) using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/create-auth-token-from-console.mdx b/pages/serverless-functions/how-to/create-auth-token-from-console.mdx index 4fe5cdaf3b..2f4f8d12e2 100644 --- a/pages/serverless-functions/how-to/create-auth-token-from-console.mdx +++ b/pages/serverless-functions/how-to/create-auth-token-from-console.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create and manage an authentication token from the console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/create-manage-delete-functions-namespace.mdx b/pages/serverless-functions/how-to/create-manage-delete-functions-namespace.mdx index 00ca37f71e..4b4c97caca 100644 --- a/pages/serverless-functions/how-to/create-manage-delete-functions-namespace.mdx +++ b/pages/serverless-functions/how-to/create-manage-delete-functions-namespace.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create, manage, and delete a Functions namespace using the Scaleway console. [Namespaces](/serverless-functions/concepts/#namespace) allow you to group your [functions](/serverless-functions/concepts/#serverless-functions) and share environment variables, secrets and tokens between them. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/delete-a-function.mdx b/pages/serverless-functions/how-to/delete-a-function.mdx index 65a318ccd9..65a2183e3c 100644 --- a/pages/serverless-functions/how-to/delete-a-function.mdx +++ b/pages/serverless-functions/how-to/delete-a-function.mdx @@ -9,6 +9,8 @@ dates: validation: 2025-02-11 posted: 2021-05-26 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a function. @@ -16,7 +18,7 @@ This page shows you how to delete a function. This action is irreversible, and permanently deletes your function and all its data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/manage-a-function.mdx b/pages/serverless-functions/how-to/manage-a-function.mdx index ffd179f76b..9d5a6d6ba8 100644 --- a/pages/serverless-functions/how-to/manage-a-function.mdx +++ b/pages/serverless-functions/how-to/manage-a-function.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to manage a function, in order to edit it, or verify/change its deployment parameters after creation. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/monitor-function.mdx b/pages/serverless-functions/how-to/monitor-function.mdx index 4b1dabc839..8ccfda15a5 100644 --- a/pages/serverless-functions/how-to/monitor-function.mdx +++ b/pages/serverless-functions/how-to/monitor-function.mdx @@ -13,6 +13,8 @@ categories: - serverless - functions --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Serverless Functions is fully integrated into [Cockpit](/cockpit/quickstart/), and allows you to quickly access your logs and metrics. This page explains how to get started with Scaleway Cockpit to monitor your Serverless Functions. @@ -20,7 +22,7 @@ Scaleway Serverless Functions is fully integrated into [Cockpit](/cockpit/quicks Use your Cockpit logs and metrics to fine-tune the resources allocated to your Serverless Functions to avoid bottlenecks and over-provisioning. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/package-function-dependencies-in-zip.mdx b/pages/serverless-functions/how-to/package-function-dependencies-in-zip.mdx index dd4af5f3a8..fede78d6ac 100644 --- a/pages/serverless-functions/how-to/package-function-dependencies-in-zip.mdx +++ b/pages/serverless-functions/how-to/package-function-dependencies-in-zip.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to upload your functions and their dependencies as a zip file using the Scaleway console. This feature allows you to add your libraries or static files to your function. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/secure-a-function.mdx b/pages/serverless-functions/how-to/secure-a-function.mdx index 1ea39e1190..ea5432a591 100644 --- a/pages/serverless-functions/how-to/secure-a-function.mdx +++ b/pages/serverless-functions/how-to/secure-a-function.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page explains how to secure your function. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/test-a-function.mdx b/pages/serverless-functions/how-to/test-a-function.mdx index 41c03351de..622242976b 100644 --- a/pages/serverless-functions/how-to/test-a-function.mdx +++ b/pages/serverless-functions/how-to/test-a-function.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to execute Serverless Functions from the [Scaleway console](https://console.scaleway.com). The **Test** feature of a function allows you to run your code using a selection of methods to make sure it behaves as expected. @@ -19,7 +21,7 @@ This page shows you how to execute Serverless Functions from the [Scaleway conso Testing **Private** Serverless Functions is not possible using the Scaleway console due to CORS limitations. Refer to the [dedicated documentation](/serverless-functions/how-to/create-auth-token-from-console/) for more information on how to secure and test a private function. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/how-to/use-private-networks.mdx b/pages/serverless-functions/how-to/use-private-networks.mdx index 361c542887..2bb1afaef4 100644 --- a/pages/serverless-functions/how-to/use-private-networks.mdx +++ b/pages/serverless-functions/how-to/use-private-networks.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + [Private Networks](/serverless-functions/concepts/#private-networks) allow your Serverless Functions to communicate in an isolated and secure network without needing to be connected to the public internet. Each function can be connected to one or several Private Networks, letting you build your own network topologies. @@ -21,7 +23,7 @@ For full information about Scaleway Private Networks and VPC, see our [dedicated The Private Networks feature can only be enabled on newly created namespaces. Existing namespaces that do not have the feature enabled cannot be integrated in a Private Network. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/index.mdx b/pages/serverless-functions/index.mdx index 362eea9f0b..0f6bd0b26d 100644 --- a/pages/serverless-functions/index.mdx +++ b/pages/serverless-functions/index.mdx @@ -4,7 +4,7 @@ meta: description: Overview of Scaleway Serverless Functions and their features. --- - - - - - \ No newline at end of file +/> diff --git a/pages/serverless-functions/quickstart.mdx b/pages/serverless-functions/quickstart.mdx index f2228900fe..2660d18ea2 100644 --- a/pages/serverless-functions/quickstart.mdx +++ b/pages/serverless-functions/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Serverless Functions makes your [functions](/serverless-functions/concepts/#serverless-functions) available, executes them on demand and manages resource allocation for you. @@ -29,7 +31,7 @@ This page explains how to deploy, invoke, and delete a basic Node, Python, or PH Follow this guided tour to discover how to deploy a function using the console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/reference-content/code-examples.mdx b/pages/serverless-functions/reference-content/code-examples.mdx index cc4002057e..5da97e3112 100644 --- a/pages/serverless-functions/reference-content/code-examples.mdx +++ b/pages/serverless-functions/reference-content/code-examples.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows examples of functions in [Python](#python), [Node](#node), [Golang](#go), [PHP](#php), and [Rust](#rust) that can be used in your Serverless Functions projects. @@ -19,7 +21,7 @@ This page shows examples of functions in [Python](#python), [Node](#node), [Gola You can find many more advanced examples and real-life use cases using Serverless products in our [Serverless Examples repository](https://github.com/scaleway/serverless-examples). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-functions/reference-content/cron-schedules.mdx b/pages/serverless-functions/reference-content/cron-schedules.mdx index cd3afb4c45..7595197285 100644 --- a/pages/serverless-functions/reference-content/cron-schedules.mdx +++ b/pages/serverless-functions/reference-content/cron-schedules.mdx @@ -13,5 +13,7 @@ categories: - serverless - functions --- +import CronSchedules from '@macros/serverless/cron-schedules.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-functions/reference-content/difference-jobs-functions-containers.mdx b/pages/serverless-functions/reference-content/difference-jobs-functions-containers.mdx index 5f3d45eb50..4eb666a234 100644 --- a/pages/serverless-functions/reference-content/difference-jobs-functions-containers.mdx +++ b/pages/serverless-functions/reference-content/difference-jobs-functions-containers.mdx @@ -13,5 +13,7 @@ categories: - serverless - functions --- +import DifferenceJobsFunctionsContainers from '@macros/serverless/difference-jobs-functions-containers.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-functions/reference-content/dns-query-rate-limit.mdx b/pages/serverless-functions/reference-content/dns-query-rate-limit.mdx index 3f01a700b0..00a1ed5099 100644 --- a/pages/serverless-functions/reference-content/dns-query-rate-limit.mdx +++ b/pages/serverless-functions/reference-content/dns-query-rate-limit.mdx @@ -13,5 +13,7 @@ categories: - serverless - functions --- +import DnsQueryRateLimit from '@macros/serverless/dns-query-rate-limit.mdx' - + + diff --git a/pages/serverless-functions/troubleshooting/index.mdx b/pages/serverless-functions/troubleshooting/index.mdx index 5943851d4b..d62386187f 100644 --- a/pages/serverless-functions/troubleshooting/index.mdx +++ b/pages/serverless-functions/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: FunctionsProductIcon ## Featured Pages - - - - - - + + diff --git a/pages/serverless-jobs/api-cli/migrate-external-image-to-scaleway-registry.mdx b/pages/serverless-jobs/api-cli/migrate-external-image-to-scaleway-registry.mdx index e06cd0dae8..cdef251972 100644 --- a/pages/serverless-jobs/api-cli/migrate-external-image-to-scaleway-registry.mdx +++ b/pages/serverless-jobs/api-cli/migrate-external-image-to-scaleway-registry.mdx @@ -12,14 +12,17 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + Serverless Jobs rely on container images. These images can be stored in the Scaleway Container Registry, or in external public registries. - + This page explains how to migrate images from public external container registries (such as Docker Hub, Amazon container registries, GitHub Container Registry, etc.) to the [Scaleway Container registry](/container-registry/concepts/#container-registry). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/faq.mdx b/pages/serverless-jobs/faq.mdx index 2eb5b8ee21..0e38ca188a 100644 --- a/pages/serverless-jobs/faq.mdx +++ b/pages/serverless-jobs/faq.mdx @@ -9,6 +9,8 @@ dates: category: serverless productIcon: ServerlessJobsProductIcon --- +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + ## Overview @@ -126,7 +128,7 @@ When starting a job, you can use contextual options to define the number of jobs ### Where should I host my jobs images for deployment? - + ### How can I copy an image from an external registry to Scaleway Container Registry? diff --git a/pages/serverless-jobs/how-to/automate-resources-management.mdx b/pages/serverless-jobs/how-to/automate-resources-management.mdx index 94c595db8b..9f1a40182b 100644 --- a/pages/serverless-jobs/how-to/automate-resources-management.mdx +++ b/pages/serverless-jobs/how-to/automate-resources-management.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-06-23 posted: 2025-06-13 --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This page shows how to create jobs to perform any operation available with the [Scaleway CLI](https://github.com/scaleway/scaleway-cli/blob/master/docs/commands/config.md) to automate the management of your Scaleway resources. Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/pages/serverless-jobs/how-to/configure-alerts-jobs.mdx b/pages/serverless-jobs/how-to/configure-alerts-jobs.mdx index 7e2f7bde44..82e112d52c 100644 --- a/pages/serverless-jobs/how-to/configure-alerts-jobs.mdx +++ b/pages/serverless-jobs/how-to/configure-alerts-jobs.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure alerts for Scaleway Serverless Jobs using Scaleway Cockpit and Grafana. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/create-job.mdx b/pages/serverless-jobs/how-to/create-job.mdx index 2c77824ceb..45843309ef 100644 --- a/pages/serverless-jobs/how-to/create-job.mdx +++ b/pages/serverless-jobs/how-to/create-job.mdx @@ -13,12 +13,15 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' +import ContainerRegistryNote from '@macros/serverless/container-registry-note.mdx' + This page shows you how to create Serverless Jobs using the [Scaleway console](https://console.scaleway.com/). You can create a job from the [Scaleway Container Registry](/container-registry/quickstart/), or any other public container registry, such as Docker Hub, AWS Container registries, GitLab container registry, etc. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -90,7 +93,7 @@ Scaleway Serverless Jobs allows you to create jobs from external public [contain Private external container registries are currently not supported. - + 1. Click **Jobs** in the **Serverless** section of the side menu. The jobs page displays. diff --git a/pages/serverless-jobs/how-to/delete-job.mdx b/pages/serverless-jobs/how-to/delete-job.mdx index d2a4944865..e3324c7ef1 100644 --- a/pages/serverless-jobs/how-to/delete-job.mdx +++ b/pages/serverless-jobs/how-to/delete-job.mdx @@ -13,6 +13,8 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a Serverless Job. @@ -20,7 +22,7 @@ This page shows you how to delete a Serverless Job. This action is irreversible, and permanently deletes your job and all its associated data. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/manage-job-schedule.mdx b/pages/serverless-jobs/how-to/manage-job-schedule.mdx index c51d0beb51..026a635a51 100644 --- a/pages/serverless-jobs/how-to/manage-job-schedule.mdx +++ b/pages/serverless-jobs/how-to/manage-job-schedule.mdx @@ -12,10 +12,12 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + Job scheduling allows you to execute a Serverless Job on a recurring schedule, based on a [cron expression](/serverless-jobs/reference-content/cron-schedules/), in the `* * * * *` format, using the desired time zone. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/monitor-job.mdx b/pages/serverless-jobs/how-to/monitor-job.mdx index c9ead64448..350b6585db 100644 --- a/pages/serverless-jobs/how-to/monitor-job.mdx +++ b/pages/serverless-jobs/how-to/monitor-job.mdx @@ -13,10 +13,12 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + You can monitor the activity of your Serverless Jobs using the [Scaleway console](https://console.scaleway.com) to check the current status, RAM, and CPU consumption of your runs. Also, Serverless Jobs is fully integrated into Scaleway’s Observability [Cockpit](/cockpit/quickstart/), and allows you to quickly access your logs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/reference-secret-in-job.mdx b/pages/serverless-jobs/how-to/reference-secret-in-job.mdx index 9a3b75718d..7f354514fd 100644 --- a/pages/serverless-jobs/how-to/reference-secret-in-job.mdx +++ b/pages/serverless-jobs/how-to/reference-secret-in-job.mdx @@ -13,6 +13,8 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + Serverless Jobs seamlessly integrates with [Secret Manager](/secret-manager/), which allows you to store, manage, and access sensitive information, such as credentials, SSH keys, SSL/TLS certificates, or any key/value pairs you need to secure. @@ -24,7 +26,7 @@ A [job run](/serverless-jobs/concepts/#job-run) accesses each secret at startup, Serverless Jobs can only reference secrets stored in the same [region](/secret-manager/concepts/#region). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/run-job.mdx b/pages/serverless-jobs/how-to/run-job.mdx index 3ebd13b882..b351072c10 100644 --- a/pages/serverless-jobs/how-to/run-job.mdx +++ b/pages/serverless-jobs/how-to/run-job.mdx @@ -13,10 +13,12 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to manually run a Serverless Job from the Scaleway console. You can also run a Serverless Job with contextual options that only apply to one run. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/how-to/stop-job.mdx b/pages/serverless-jobs/how-to/stop-job.mdx index a43fbfec38..d4d248703c 100644 --- a/pages/serverless-jobs/how-to/stop-job.mdx +++ b/pages/serverless-jobs/how-to/stop-job.mdx @@ -13,10 +13,12 @@ categories: - serverless - jobs --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to manually stop a Serverless Job from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-jobs/index.mdx b/pages/serverless-jobs/index.mdx index e2993bf7fd..ac3a2b39eb 100644 --- a/pages/serverless-jobs/index.mdx +++ b/pages/serverless-jobs/index.mdx @@ -4,7 +4,7 @@ meta: description: Introduction to Scaleway Serverless Jobs. --- - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -56,7 +59,7 @@ Discover the Serverless Jobs interface in the Scaleway console. 4. Click **Create a job definition** to finish. - + ## How to run a job diff --git a/pages/serverless-jobs/reference-content/cron-schedules.mdx b/pages/serverless-jobs/reference-content/cron-schedules.mdx index e782c9fdb7..88c1bba113 100644 --- a/pages/serverless-jobs/reference-content/cron-schedules.mdx +++ b/pages/serverless-jobs/reference-content/cron-schedules.mdx @@ -13,5 +13,7 @@ categories: - serverless - jobs --- +import CronSchedules from '@macros/serverless/cron-schedules.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-jobs/reference-content/difference-jobs-functions-containers.mdx b/pages/serverless-jobs/reference-content/difference-jobs-functions-containers.mdx index 9eb8683506..f938c4b363 100644 --- a/pages/serverless-jobs/reference-content/difference-jobs-functions-containers.mdx +++ b/pages/serverless-jobs/reference-content/difference-jobs-functions-containers.mdx @@ -13,5 +13,7 @@ categories: - serverless - jobs --- +import DifferenceJobsFunctionsContainers from '@macros/serverless/difference-jobs-functions-containers.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/serverless-jobs/troubleshooting/index.mdx b/pages/serverless-jobs/troubleshooting/index.mdx index 0504dfbec3..05a4c5ce80 100644 --- a/pages/serverless-jobs/troubleshooting/index.mdx +++ b/pages/serverless-jobs/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: ServerlessJobsProductIcon ## Featured Pages - - - - - - + + diff --git a/pages/serverless-sql-databases/api-cli/import-data-to-serverless-sql-databases.mdx b/pages/serverless-sql-databases/api-cli/import-data-to-serverless-sql-databases.mdx index 58663ecc4b..787a5df952 100644 --- a/pages/serverless-sql-databases/api-cli/import-data-to-serverless-sql-databases.mdx +++ b/pages/serverless-sql-databases/api-cli/import-data-to-serverless-sql-databases.mdx @@ -10,6 +10,8 @@ dates: validation: 2025-01-03 posted: 2024-06-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Serverless SQL Databases offers near-complete PostgreSQL compatibility, and allows you to import your data from any PostgreSQL-compatible database. @@ -17,7 +19,7 @@ Serverless SQL Databases offers near-complete PostgreSQL compatibility, and allo The methods listed below are best suited for database sizes below 100 GB (approx.). Above this size, we recommend you use dedicated tooling to import your data, as your Local Storage size and bandwidth will create bottlenecks, and the operation may last several hours. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/api-cli/postgrest-row-level-security.mdx b/pages/serverless-sql-databases/api-cli/postgrest-row-level-security.mdx index 230245b5fe..175c72b6cc 100644 --- a/pages/serverless-sql-databases/api-cli/postgrest-row-level-security.mdx +++ b/pages/serverless-sql-databases/api-cli/postgrest-row-level-security.mdx @@ -12,12 +12,14 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + PostgREST's built-in Row Level Security based on users JWT relies either on [role impersonation](https://docs.postgrest.org/en/v12/references/auth.html#user-impersonation) or [transaction-scoped settings](https://docs.postgrest.org/en/v12/references/transactions.html#tx-settings). Due to connection pooling, Serverless SQL Databases currently only support transaction-scoped settings and requires using a single PostgreSQL role for all queries (the internal `role_readwrite` in PostgreSQL). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/concepts.mdx b/pages/serverless-sql-databases/concepts.mdx index 69a86c79b9..db49c27501 100644 --- a/pages/serverless-sql-databases/concepts.mdx +++ b/pages/serverless-sql-databases/concepts.mdx @@ -11,6 +11,8 @@ dates: categories: - serverless --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + ## Active state @@ -58,7 +60,7 @@ PostgreSQL is an open-source object-relational database system known for its rel ## Region and AZ - + ## Relational database diff --git a/pages/serverless-sql-databases/how-to/add-users.mdx b/pages/serverless-sql-databases/how-to/add-users.mdx index 3ce0bab4f2..b4fd201ab3 100644 --- a/pages/serverless-sql-databases/how-to/add-users.mdx +++ b/pages/serverless-sql-databases/how-to/add-users.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Users and applications can connect to a database and access its data. Each one can have a different set of customizable permissions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/configure-autoscaling.mdx b/pages/serverless-sql-databases/how-to/configure-autoscaling.mdx index 414baca346..e85846799a 100644 --- a/pages/serverless-sql-databases/how-to/configure-autoscaling.mdx +++ b/pages/serverless-sql-databases/how-to/configure-autoscaling.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to edit the autoscaling of a Serverless SQL Database using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/connect-to-a-database.mdx b/pages/serverless-sql-databases/how-to/connect-to-a-database.mdx index f4f9300dda..3c7c09132d 100644 --- a/pages/serverless-sql-databases/how-to/connect-to-a-database.mdx +++ b/pages/serverless-sql-databases/how-to/connect-to-a-database.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to set up the connection to a Serverless SQL Database using the Scaleway console. @@ -41,7 +43,7 @@ To connect to a Serverless SQL Database, you can either use a **connection strin The `PGSSLMODE="require"` parameter is required to connect to your database, but can be omitted as it is provided by default by most SQL clients. Refer to the [dedicated documentation](/serverless-sql-databases/api-cli/secure-connection-ssl-tls/) for more information about SSL connection to Serverless SQL Databases. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/create-a-database.mdx b/pages/serverless-sql-databases/how-to/create-a-database.mdx index db6650b937..0477a59362 100644 --- a/pages/serverless-sql-databases/how-to/create-a-database.mdx +++ b/pages/serverless-sql-databases/how-to/create-a-database.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create a Serverless SQL Database using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/delete-a-database.mdx b/pages/serverless-sql-databases/how-to/delete-a-database.mdx index b1fcb86bc7..7011512736 100644 --- a/pages/serverless-sql-databases/how-to/delete-a-database.mdx +++ b/pages/serverless-sql-databases/how-to/delete-a-database.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a Serverless SQL Database using the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/manage-backups.mdx b/pages/serverless-sql-databases/how-to/manage-backups.mdx index d261a3e627..e9525ef213 100644 --- a/pages/serverless-sql-databases/how-to/manage-backups.mdx +++ b/pages/serverless-sql-databases/how-to/manage-backups.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Serverless SQL Databases are automatically backed up every day at the same time. [Backups](/serverless-sql-databases/concepts/#backup) are stored for 7 days. They are useful when you need to restore a specific state of your Serverless SQL Database. You can restore a database to a previous state, create a new database from a specific backup, or export a backup in `.pg_dump` format. @@ -19,7 +21,7 @@ Serverless SQL Databases are automatically backed up every day at the same time. The restore duration depends on the size of your database. Restore operations are considered as regular database activity, and are therefore billed the same way. Refer to our [dedicated FAQ](/serverless-sql-databases/faq/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/manage-permissions.mdx b/pages/serverless-sql-databases/how-to/manage-permissions.mdx index 09d5f06627..d2ae088bb4 100644 --- a/pages/serverless-sql-databases/how-to/manage-permissions.mdx +++ b/pages/serverless-sql-databases/how-to/manage-permissions.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Permissions define the actions a user or an application can perform on a database. They are managed using Scaleway's [Identity and Access Management](/iam/quickstart/) interface. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/how-to/use-row-level-security.mdx b/pages/serverless-sql-databases/how-to/use-row-level-security.mdx index e136cfd484..519ab6c4e5 100644 --- a/pages/serverless-sql-databases/how-to/use-row-level-security.mdx +++ b/pages/serverless-sql-databases/how-to/use-row-level-security.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Row-Level Security is a database security mechanism that allows access only to specific rows of a table based on a user's role or permissions. @@ -19,7 +21,7 @@ Row-Level Security can be activated with Serverless SQL Databases for a maximum This requires setting up different [IAM permissions sets](/iam/reference-content/permission-sets/) for each role (**ServerlessSQLDatabaseFullAccess** or **ServerlessSQLDatabaseReadWrite** for one role, and **ServerlessSQLDatabaseDataReadWrite** for the other). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/quickstart.mdx b/pages/serverless-sql-databases/quickstart.mdx index 9a8c3592f1..1112c87496 100644 --- a/pages/serverless-sql-databases/quickstart.mdx +++ b/pages/serverless-sql-databases/quickstart.mdx @@ -12,6 +12,8 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Serverless SQL Databases are fully managed databases that automatically scale in storage and compute according to your workloads. @@ -21,7 +23,7 @@ This page explains how to create, access, and delete a Serverless SQL Database u Discover the Serverless SQL Databases interface in the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/reference-content/serverless-sql-databases-overview.mdx b/pages/serverless-sql-databases/reference-content/serverless-sql-databases-overview.mdx index 6d3d561e3f..5ebfec42b6 100644 --- a/pages/serverless-sql-databases/reference-content/serverless-sql-databases-overview.mdx +++ b/pages/serverless-sql-databases/reference-content/serverless-sql-databases-overview.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import image from './assets/serverless-sql-databases-schema.webp' + Scaleway Serverless SQL Databases are fully managed databases that automatically scale both in storage and compute according to your workloads. - + ## Idle state After receiving no query for 5 minutes, a Serverless SQL Database will enter into an idle state. It switches from **Running** to **Ready to use**, even if your client applications are still connected. diff --git a/pages/serverless-sql-databases/reference-content/supported-postgresql-extensions.mdx b/pages/serverless-sql-databases/reference-content/supported-postgresql-extensions.mdx index cf99b4cd45..5c36adfcc9 100644 --- a/pages/serverless-sql-databases/reference-content/supported-postgresql-extensions.mdx +++ b/pages/serverless-sql-databases/reference-content/supported-postgresql-extensions.mdx @@ -12,10 +12,12 @@ dates: categories: - serverless --- +import Requirements from '@macros/iam/requirements.mdx' + Serverless SQL Databases support the most popular PostgreSQL extensions. Due to autoscaling and built-in connection pooling, some [advanced features of extensions might be limited or require workarounds](#supported-extensions). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/serverless-sql-databases/troubleshooting/index.mdx b/pages/serverless-sql-databases/troubleshooting/index.mdx index 80d5aef66d..51db7e1bd4 100644 --- a/pages/serverless-sql-databases/troubleshooting/index.mdx +++ b/pages/serverless-sql-databases/troubleshooting/index.mdx @@ -21,19 +21,19 @@ productIcon: ServerlessDbProductIcon ## Featured Pages - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - initialized the [Scaleway configuration file](/terraform/reference-content/scaleway-configuration-file/) diff --git a/pages/terraform/reference-content/environment-variables.mdx b/pages/terraform/reference-content/environment-variables.mdx index 9f83220a6c..1048ab1640 100644 --- a/pages/terraform/reference-content/environment-variables.mdx +++ b/pages/terraform/reference-content/environment-variables.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayEnvironmentVariables from '@macros/developer-tools/scaleway-environment-variables.mdx' - + + diff --git a/pages/terraform/reference-content/scaleway-configuration-file.mdx b/pages/terraform/reference-content/scaleway-configuration-file.mdx index c90f0cf16d..f359782a47 100644 --- a/pages/terraform/reference-content/scaleway-configuration-file.mdx +++ b/pages/terraform/reference-content/scaleway-configuration-file.mdx @@ -12,5 +12,7 @@ dates: categories: - devtools --- +import ScalewayConfigurationFile from '@macros/developer-tools/scaleway-configuration-file.mdx' - \ No newline at end of file + + \ No newline at end of file diff --git a/pages/topics-and-events/api-cli/connect-aws-cli.mdx b/pages/topics-and-events/api-cli/connect-aws-cli.mdx index 978e6714d3..cf5fec98e3 100644 --- a/pages/topics-and-events/api-cli/connect-aws-cli.mdx +++ b/pages/topics-and-events/api-cli/connect-aws-cli.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-04-10 posted: 2023-01-04 --- +import Requirements from '@macros/iam/requirements.mdx' + The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. With minimal configuration, you can start using the AWS-CLI with Scaleway Topics and Events. This allows you to create, list and manage your topics, send messages and much more, all from your command line. This guide shows you how to install the AWS-CLI and configure it to connect to Scaleway Topics and Events. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/topics-and-events/api-cli/python-node-topics-events.mdx b/pages/topics-and-events/api-cli/python-node-topics-events.mdx index 00b422e221..3feaa2462f 100644 --- a/pages/topics-and-events/api-cli/python-node-topics-events.mdx +++ b/pages/topics-and-events/api-cli/python-node-topics-events.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-14 posted: 2023-01-04 --- +import Requirements from '@macros/iam/requirements.mdx' + AWS provides a number of **S**oftware **D**evelopment **K**its (SDKs) which provide language-specific APIs for AWS services, including [SNS](/topics-and-events/concepts/#sns), which is the protocol that Scaleway Topics and Events is based on. @@ -22,7 +24,7 @@ AWS provides a number of **S**oftware **D**evelopment **K**its (SDKs) which prov This page provides code samples to show you how to get started using these SDKs with Scaleway Topics and Events. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/topics-and-events/api-cli/topics-events-aws-cli.mdx b/pages/topics-and-events/api-cli/topics-events-aws-cli.mdx index 3f585d9d53..29d856d53c 100644 --- a/pages/topics-and-events/api-cli/topics-events-aws-cli.mdx +++ b/pages/topics-and-events/api-cli/topics-events-aws-cli.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-04-10 posted: 2023-04-04 --- +import Requirements from '@macros/iam/requirements.mdx' + The AWS-CLI is an open-source tool built on top of the AWS SDK for Python (Boto) that provides commands for interacting with AWS services. Once you have [connected Scaleway Topics and Events to the AWS-CLI](/topics-and-events/api-cli/connect-aws-cli/), you can start creating, listing and managing your topics, sending messages and much more, all from your command line. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/topics-and-events/how-to/create-credentials.mdx b/pages/topics-and-events/how-to/create-credentials.mdx index b07daed925..784c198f13 100644 --- a/pages/topics-and-events/how-to/create-credentials.mdx +++ b/pages/topics-and-events/how-to/create-credentials.mdx @@ -13,12 +13,16 @@ dates: validation: 2025-04-10 posted: 2025-04-10 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-topics-gen-creds.webp' + This page shows how to create [credentials](/topics-and-events/concepts/#credentials) for Scaleway Topics and Events. Credentials give their bearer (e.g. services and platforms) access to your service. Credentials for Topics and Events are granular: you can define the level of access that they should give. Credentials give the specified level of access to all topics that you create in the region they are scoped to. You can create multiple sets of credentials for each of your Topics and Events services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -29,7 +33,7 @@ Credentials for Topics and Events are granular: you can define the level of acce 3. Click **Generate credentials**. A pop-up displays: - + 4. Choose a region that these credentials should be scoped to. diff --git a/pages/topics-and-events/how-to/create-manage-subscriptions.mdx b/pages/topics-and-events/how-to/create-manage-subscriptions.mdx index f64809fba5..201addfee9 100644 --- a/pages/topics-and-events/how-to/create-manage-subscriptions.mdx +++ b/pages/topics-and-events/how-to/create-manage-subscriptions.mdx @@ -13,10 +13,14 @@ dates: validation: 2025-05-14 posted: 2024-02-06 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-topics-create-subs.webp' + This page shows how to create and manage [subscriptions](/topics-and-events/concepts/#subscription) with Scaleway Topics and Events (formerly part of the Messaging and Queuing product). When you create a subscription to a [topic](/topics-and-events/concepts/#topic), you are effectively signing up an endpoint to receive all messages published to that topic. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -31,7 +35,7 @@ This page shows how to create and manage [subscriptions](/topics-and-events/conc 3. Click the name of the topic you want to create a subscription for. 4. Click **Create Subscription**. The subscription creation wizard displays. - + 5. Verify the parameters of the topic that you are creating a subscription for (name, and type). diff --git a/pages/topics-and-events/how-to/create-manage-topics.mdx b/pages/topics-and-events/how-to/create-manage-topics.mdx index 34cc85ac0f..4764fce9f3 100644 --- a/pages/topics-and-events/how-to/create-manage-topics.mdx +++ b/pages/topics-and-events/how-to/create-manage-topics.mdx @@ -13,10 +13,14 @@ dates: validation: 2025-04-10 posted: 2023-12-27 --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-topics-create-topic.webp' + This page shows how to create and manage [topics](/topics-and-events/concepts/#topic) with Scaleway Topics and Events. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -27,7 +31,7 @@ This page shows how to create and manage [topics](/topics-and-events/concepts/#t 2. Click **Create topic**. The topic creation wizard displays. - + 3. Choose a region in which to create your topic. diff --git a/pages/topics-and-events/how-to/manage-credentials.mdx b/pages/topics-and-events/how-to/manage-credentials.mdx index ccbbb4f1c0..3db8bc07c2 100644 --- a/pages/topics-and-events/how-to/manage-credentials.mdx +++ b/pages/topics-and-events/how-to/manage-credentials.mdx @@ -13,12 +13,14 @@ categories: - serverless - topics-and-events --- +import Requirements from '@macros/iam/requirements.mdx' + Credentials give their bearer (e.g. services and platforms) access to your service. This page shows how to manage [credentials](/topics-and-events/concepts/#credentials) for Scaleway Topics and Events. Credentials can be updated to change their permissions, or revoked. Once credentials are revoked, any user trying to use the credentials to connect to the service will be denied. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/topics-and-events/how-to/monitor-topics-cockpit.mdx b/pages/topics-and-events/how-to/monitor-topics-cockpit.mdx index 911fbc3c4c..61b003c1a5 100644 --- a/pages/topics-and-events/how-to/monitor-topics-cockpit.mdx +++ b/pages/topics-and-events/how-to/monitor-topics-cockpit.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-10 posted: 2023-09-07 --- +import Requirements from '@macros/iam/requirements.mdx' + You can view metrics for Topics and Events via [Scaleway Cockpit](/cockpit/quickstart/). This allows you to monitor your topics and messages at a glance. There are two steps to complete to view your metrics for the first time with Cockpit: @@ -20,7 +22,7 @@ You can view metrics for Topics and Events via [Scaleway Cockpit](/cockpit/quick These steps are described below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/topics-and-events/index.mdx b/pages/topics-and-events/index.mdx index 1b7abebfd6..367b6a1b8c 100644 --- a/pages/topics-and-events/index.mdx +++ b/pages/topics-and-events/index.mdx @@ -4,7 +4,7 @@ meta: description: Explore Scaleway Topics and Events. Simplify your microservice workflows with scalable, reliable, and cost-effective message handling solutions. --- - - \ No newline at end of file +/> diff --git a/pages/topics-and-events/quickstart.mdx b/pages/topics-and-events/quickstart.mdx index c089dd2de0..67b02c1f36 100644 --- a/pages/topics-and-events/quickstart.mdx +++ b/pages/topics-and-events/quickstart.mdx @@ -13,6 +13,12 @@ categories: - serverless - topics-and-events --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-topics-gen-creds.webp' +import image2 from './assets/scaleway-topics-create-topic.webp' +import image3 from './assets/scaleway-topics-create-subs.webp' + Scaleway Topics and Events is a message broker tool that allows you to transfer messages between different microservices and platforms. This enables them to "talk" to each other effectively even if they are not otherwise compatible. Topics and Events enable and simplify microservices application development and allows you to build highly scalable, reliable, distributed applications. @@ -20,7 +26,7 @@ Scaleway Topics and Events is a message broker tool that allows you to transfer Discover the Topics and Events interface on the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -35,7 +41,7 @@ Credentials for Topics and Events are granular: you can define the level of acce 3. Click **Generate credentials**. A pop-up displays: - + 4. Choose a region that these credentials should be scoped to. @@ -61,7 +67,7 @@ Credentials for Topics and Events are granular: you can define the level of acce 2. Click **Create topic**. The topic creation wizard displays. - + 3. Choose a region in which to create your topic. @@ -84,7 +90,7 @@ You are returned to the **Topics** tab, where your newly-created topic now displ 3. Click the name of the topic you want to create a subscription for. 4. Click **Create Subscription**. The subscription creation wizard displays. - + 5. Verify the parameters of the topic that you are creating a subscription for (name and type). diff --git a/pages/topics-and-events/troubleshooting/index.mdx b/pages/topics-and-events/troubleshooting/index.mdx index 7016e17ccf..5a0076f51c 100644 --- a/pages/topics-and-events/troubleshooting/index.mdx +++ b/pages/topics-and-events/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: SnsProductIcon ## Featured Pages - - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Configured your API key](/iam/how-to/create-api-keys/) diff --git a/pages/transactional-email/api-cli/use-webhooks-with-sns-topics.mdx b/pages/transactional-email/api-cli/use-webhooks-with-sns-topics.mdx index f64af9a4e3..752a0ad1bc 100644 --- a/pages/transactional-email/api-cli/use-webhooks-with-sns-topics.mdx +++ b/pages/transactional-email/api-cli/use-webhooks-with-sns-topics.mdx @@ -12,12 +12,16 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-webhook-site.webp' + A webhook is an automated message sent in real-time from one system to another when a specific event happens, the message is typically conveyed using HTTP requests that are sent to an endpoint of your choice. You can set up webhooks for Scaleway Transactional Email and subscribe them to [Topics and Events topics](/topics-and-events/how-to/create-manage-topics/) to have real-time event alerts sent to your endpoints. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -34,7 +38,7 @@ You can set up webhooks for Scaleway Transactional Email and subscribe them to [ If you do not yet have a webhook URL, you can use the tool [webhook.site](https://webhook.site/) to generate one and receive your events on the interface.

When you access the website, a URL is generated automatically. You can copy it and add it as your endpoint when configuring your SNS subscription. - + 4. [Confirm your subscription](/topics-and-events/how-to/create-manage-subscriptions/#how-to-confirm-an-http-or-https-subscription). diff --git a/pages/transactional-email/concepts.mdx b/pages/transactional-email/concepts.mdx index 28471b5979..0c7de5835a 100644 --- a/pages/transactional-email/concepts.mdx +++ b/pages/transactional-email/concepts.mdx @@ -11,6 +11,10 @@ dates: categories: - managed-services --- +import DedicatedIp from '@macros/tem/dedicated-ip.mdx' +import WebhookEventStatus from '@macros/tem/webhook-event-status.mdx' +import WebhookEventTypes from '@macros/tem/webhook-event-types.mdx' + ## Aggregate report @@ -22,7 +26,7 @@ Blocklist is a feature that allows you to manage email addresses that generate e ## Dedicated IPs - + Refer to the [Understanding managed dedicated IPs](/transactional-email/reference-content/tem-dedicated-ip) documentation page for more information. @@ -208,8 +212,8 @@ Two plans are available: ## Webhook Event Type - + ## Webhook Event Status - \ No newline at end of file + \ No newline at end of file diff --git a/pages/transactional-email/how-to/add-dmarc-record.mdx b/pages/transactional-email/how-to/add-dmarc-record.mdx index 48811d3602..5074d40fe1 100644 --- a/pages/transactional-email/how-to/add-dmarc-record.mdx +++ b/pages/transactional-email/how-to/add-dmarc-record.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure a basic [DMARC record](/transactional-email/concepts/#dmarc-record) on your domain. If you have registered a domain at Scaleway Domains and DNS, you can still use this documentation, as the process is similar. For more information about DMARC configuration and examples of DMARC records you can configure, refer to the [dedicated documentation](/transactional-email/reference-content/dmarc-configuration/). - + - A Scaleway account logged into the [console](https://console.scaleway.com/) - A domain name diff --git a/pages/transactional-email/how-to/add-mx-record-to-your-domain.mdx b/pages/transactional-email/how-to/add-mx-record-to-your-domain.mdx index bad271327a..40c7498e48 100644 --- a/pages/transactional-email/how-to/add-mx-record-to-your-domain.mdx +++ b/pages/transactional-email/how-to/add-mx-record-to-your-domain.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Setting up an [MX record](/transactional-email/concepts/#mx-record) ensures that your emails are delivered reliably. This page explains how to set up **your own MX record**, and how to set up Scaleway's blackhole MX if you do not have your own MX server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A domain name - [Configured your domain with Transactional Email](/transactional-email/how-to/configure-domain-with-transactional-email/) diff --git a/pages/transactional-email/how-to/add-spf-dkim-records-to-your-domain.mdx b/pages/transactional-email/how-to/add-spf-dkim-records-to-your-domain.mdx index aadc15fcd9..8a6383dee3 100644 --- a/pages/transactional-email/how-to/add-spf-dkim-records-to-your-domain.mdx +++ b/pages/transactional-email/how-to/add-spf-dkim-records-to-your-domain.mdx @@ -12,12 +12,17 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_dkim_record_name.webp' +import image2 from './assets/scaleway_dkim_name_value.webp' + This page shows you how to set up [SPF](/transactional-email/concepts/#spf-record) and [DKIM](/transactional-email/concepts/#dkim-record) records to your domain to verify it. After you have configured your domain with Transactional Email, you are prompted to verify your domain by adding [SPF](/transactional-email/concepts/#spf-record), [DKIM](/transactional-email/concepts/#dkim-record), [DMARC](/transactional-email/how-to/add-dmarc-record) and [MX](/transactional-email/concepts/#mx-record). You can choose to do so right after you have validated your domain, or at a later time. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -36,10 +41,10 @@ After you have configured your domain with Transactional Email, you are prompted 5. Paste the value you have copied in the root zone of your domain. 6. Add an additional `TXT` record type in the root zone of your domain on your DNS zone. 7. Copy the name that displays in the console. - + 8. Paste the name you have copied in the root zone of your domain on your DNS zone. 9. Copy the value that displays in the console and paste it in the root zone of your domain on your DNS zone. - + 10. Add an [MX record](/transactional-email/how-to/add-mx-record-to-your-domain/). 11. Check the box "I have added these DNS records to my DNS zone" to confirm. 12. Click **Verify domain**. Your domain displays in the list of your domains. diff --git a/pages/transactional-email/how-to/autoconfigure-domain.mdx b/pages/transactional-email/how-to/autoconfigure-domain.mdx index 2a29d4ec14..c1795808f4 100644 --- a/pages/transactional-email/how-to/autoconfigure-domain.mdx +++ b/pages/transactional-email/how-to/autoconfigure-domain.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + With Scaleway domains, you can now benefit from automatic DNS record creation and updates (autoconfiguration) for domains already registered with the Transactional Email service. Automatic configuration of your DNS zone streamlines the setup of your domain for Transactional Email, allowing you to focus on sending emails and tracking traffic without manual configuration delays. @@ -22,7 +24,7 @@ You can enable autoconfiguration directly from the Scaleway console (see instruc This documentation covers the use of DNS autoconfiguration for domains already registerd with Transactional Email. If you want to add a new domain, refer to [How to configure your sending domain with Transactional Email](/transactional-email/how-to/configure-domain-with-transactional-email/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/configure-bimi.mdx b/pages/transactional-email/how-to/configure-bimi.mdx index 042b89fa79..f150759109 100644 --- a/pages/transactional-email/how-to/configure-bimi.mdx +++ b/pages/transactional-email/how-to/configure-bimi.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import image from './assets/scaleway-bimi-record.webp' + Scaleway supports SPF, DKIM and DMARC with Transactional Email, which makes it possible for your to set up BIMI, or Brand Indicators for Message Identification. BIMI is an email specification that allows you to use your brand's logo within email clients to help demonstrate the authenticity of your emails. BIMI helps reduce the risk of phishing and spoofing, for example, as brand indicators are used as a tool to identify if fraud is occurring. @@ -47,7 +49,7 @@ In this tutorial we use [Scaleway Domains and DNS](/domains-and-dns/how-to/manag 4. Click **+ Add records** to add new records to your DNS zone. A pop-up displays. 5. Fill in the required information for the record. - + | Field | Value | Notes | | ------| ------- | ----- | diff --git a/pages/transactional-email/how-to/configure-domain-with-transactional-email.mdx b/pages/transactional-email/how-to/configure-domain-with-transactional-email.mdx index 2dad46c593..c76a31ecae 100644 --- a/pages/transactional-email/how-to/configure-domain-with-transactional-email.mdx +++ b/pages/transactional-email/how-to/configure-domain-with-transactional-email.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to configure your sending domain to start sending [transactional emails](/transactional-email/concepts/#transactional-email). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/create-webhooks.mdx b/pages/transactional-email/how-to/create-webhooks.mdx index 443179c0a9..c3bac17408 100644 --- a/pages/transactional-email/how-to/create-webhooks.mdx +++ b/pages/transactional-email/how-to/create-webhooks.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + A webhook is an automated message sent in real-time from one system to another when a specific event happens, the message is typically conveyed using HTTP requests that are sent to an endpoint of your choice. @@ -23,7 +25,7 @@ You can set up webhooks for Scaleway Transactional Email and subscribe them to [ Currently, webhooks are integrated exclusively with the Scaleway Topics and Events. Billing for webhooks is based on the Scaleway [Topics and Events billing](https://www.scaleway.com/en/pricing/managed-databases/#messaging-and-queuing). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/delete-tem-domain.mdx b/pages/transactional-email/how-to/delete-tem-domain.mdx index 8e5b6025ea..e7c339c1e1 100644 --- a/pages/transactional-email/how-to/delete-tem-domain.mdx +++ b/pages/transactional-email/how-to/delete-tem-domain.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to delete a domain that you have configured with Transactional Email. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/generate-api-keys-for-tem-with-iam.mdx b/pages/transactional-email/how-to/generate-api-keys-for-tem-with-iam.mdx index 1ca9c215a1..f106460213 100644 --- a/pages/transactional-email/how-to/generate-api-keys-for-tem-with-iam.mdx +++ b/pages/transactional-email/how-to/generate-api-keys-for-tem-with-iam.mdx @@ -9,10 +9,12 @@ dates: validation: 2025-06-02 posted: 2022-11-07 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to generate [API keys](/iam/concepts/#api-key) with IAM to send [transactional emails](/transactional-email/concepts/#transactional-email) via API and SMTP. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/manage-blocklists.mdx b/pages/transactional-email/how-to/manage-blocklists.mdx index 02dfc32335..45641d6384 100644 --- a/pages/transactional-email/how-to/manage-blocklists.mdx +++ b/pages/transactional-email/how-to/manage-blocklists.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + The Transactional Email (TEM) blocklist feature allows you to manage email addresses that generate errors, or “bounces”. Emails are automatically blocked when a mailbox does not exist, or is full, to prevent sending emails to a recipient address that is not reachable. You can also add emails to the blocklist manually if you subscribe to the [TEM Scale plan](/transactional-email/concepts/#scale-plan) and have a Scaleway domain. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. For blocklists your can apply the `TransactionalEmailBlocklistFullAccess` permission diff --git a/pages/transactional-email/how-to/manage-email-activity.mdx b/pages/transactional-email/how-to/manage-email-activity.mdx index 4631019ffb..fe8086c9f2 100644 --- a/pages/transactional-email/how-to/manage-email-activity.mdx +++ b/pages/transactional-email/how-to/manage-email-activity.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to display your email activity and filter your emails using the [Scaleway console](https://console.scaleway.com/). With [flags](/transactional-email/concepts/#flags), you can also get more information on your emails' statuses. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/how-to/manage-tem-plans.mdx b/pages/transactional-email/how-to/manage-tem-plans.mdx index d9a3f0236b..fc1fbe2296 100644 --- a/pages/transactional-email/how-to/manage-tem-plans.mdx +++ b/pages/transactional-email/how-to/manage-tem-plans.mdx @@ -12,6 +12,12 @@ dates: categories: - transactional-email --- +import Requirements from '@macros/iam/requirements.mdx' +import DedicatedIp from '@macros/tem/dedicated-ip.mdx' + +import image from './assets/scaleway-tem-current-plan.webp' +import image2 from './assets/scaleway-tem-current-plan-tooltip.webp' + Plans are the service tiers for Transactional Email, each offering specific features, pricing, and usage limits to suit different needs—from occasional low-volume senders to high-volume enterprise users. Plans are scoped to Projects. @@ -19,7 +25,7 @@ Two plans are available: - **Essential** - pay-as-you-go plan designed for occasional or low-volume email sending needs. This plan offers simplified management and a single webhook per domain. - **Scale** - fixed-price plan tailored for high-volume email sending. Includes 100K emails. Additional emails are charged. This plan includes a dedicated IP address and unlimited webhooks per domain. It also features advanced blocklist management, allowing for manual additions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -55,11 +61,11 @@ Each TEM plan has a number of domains and webhooks included in the plan. To keep If you reach or surpass the free capacity of your plan, the number of resources will be indicated in red. - + You can click the information tooltip next to the number to view details on how much each resource exceeded the included amount. - + You can click **Upgrade plan** in the **Current plan** section to quickly upgrade from the Essential to the Scale plan if your included resources have been exceeded. @@ -67,7 +73,7 @@ Each TEM plan has a number of domains and webhooks included in the plan. To keep ## How to manage dedicated IPs - + You can check your IPv4 and IPv6 addresses in the **Managed Dedicated IP** section of the **Plans** tab. diff --git a/pages/transactional-email/how-to/monitor-transactional-email-cockpit.mdx b/pages/transactional-email/how-to/monitor-transactional-email-cockpit.mdx index 0ce1d9e869..81a2efadde 100644 --- a/pages/transactional-email/how-to/monitor-transactional-email-cockpit.mdx +++ b/pages/transactional-email/how-to/monitor-transactional-email-cockpit.mdx @@ -12,12 +12,14 @@ dates: categories: - transactional-email --- +import Requirements from '@macros/iam/requirements.mdx' + You can use Scaleway Cockpit to track TEM metrics and monitor email activity, detect potential deliverability issues, and check key indicators to track your domain's reputation. This page explains how to get started with Scaleway Cockpit for viewing your Transactional Email metrics and logs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/index.mdx b/pages/transactional-email/index.mdx index 2f6f323361..df7e57b9f8 100644 --- a/pages/transactional-email/index.mdx +++ b/pages/transactional-email/index.mdx @@ -49,17 +49,17 @@ meta: ## Tutorials - - - \ No newline at end of file +/> diff --git a/pages/transactional-email/quickstart.mdx b/pages/transactional-email/quickstart.mdx index 5f7fa5a109..c538bf3e67 100644 --- a/pages/transactional-email/quickstart.mdx +++ b/pages/transactional-email/quickstart.mdx @@ -12,12 +12,17 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway_dkim_record_name.webp' +import image2 from './assets/scaleway_dkim_name_value.webp' + Transactional Email is a platform that allows Scaleway clients to send [transactional emails](/transactional-email/concepts/#transactional-email) with high quality [deliverability](/transactional-email/concepts/#deliverability). In this quickstart, we show you how to configure your domain with Transactional Email, how to add SPF, DKIM and MX records to your domain, and how to delete your domain. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -55,10 +60,10 @@ After you have configured your domain with Transactional Email, you are prompted 5. Paste the value you have copied in the root zone of your domain. 6. Add an additional `TXT` type record in the root zone of your domain on your DNS zone. 7. Copy the name that displays in the console. - + 8. Paste the name you have copied in the root zone of your domain on your DNS zone. 9. Copy the value that displays in the console and paste it into the root zone of your domain on your DNS zone. - + 10. Check the box "I have added these DNS records to my DNS zone" to confirm. 11. Click **Verify domain**. Your domain displays in the list of your domains. diff --git a/pages/transactional-email/reference-content/tem-dedicated-ip.mdx b/pages/transactional-email/reference-content/tem-dedicated-ip.mdx index e7aa063e42..66e8336ae3 100644 --- a/pages/transactional-email/reference-content/tem-dedicated-ip.mdx +++ b/pages/transactional-email/reference-content/tem-dedicated-ip.mdx @@ -12,8 +12,10 @@ dates: categories: - transactional-email --- +import DedicatedIp from '@macros/tem/dedicated-ip.mdx' - + + The following dedicated IP management actions are included with the TEM Scale plan: - **Automatic IP Warm-up** - Controlled progression of sending volumes to establish a good reputation. diff --git a/pages/transactional-email/reference-content/understanding-tem-reputation-score.mdx b/pages/transactional-email/reference-content/understanding-tem-reputation-score.mdx index e831b79683..06de8d1c95 100644 --- a/pages/transactional-email/reference-content/understanding-tem-reputation-score.mdx +++ b/pages/transactional-email/reference-content/understanding-tem-reputation-score.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's Transactional Email service provides a weekly email report on your email activity, as well as alerts, to allow you to manage and improve your domain [reputation](/transactional-email/concepts/#reputation-score). This documentation provides information about the alerts we send you and advice on how to maintain a good reputation score. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/transactional-email/reference-content/webhook-events-payloads.mdx b/pages/transactional-email/reference-content/webhook-events-payloads.mdx index 5e4ef192b8..34ea3d7749 100644 --- a/pages/transactional-email/reference-content/webhook-events-payloads.mdx +++ b/pages/transactional-email/reference-content/webhook-events-payloads.mdx @@ -12,6 +12,9 @@ dates: categories: - managed-services --- +import WebhookEventStatus from '@macros/tem/webhook-event-status.mdx' +import WebhookEventTypes from '@macros/tem/webhook-event-types.mdx' + Events triggered by webhooks contain payloads that describe and detail the events. @@ -42,11 +45,11 @@ Find below a detailed description of the fields in a [Webhook event](/transactio ## Webhook event type - + ## Webhook event status - + ## Examples of payload by event type diff --git a/pages/transactional-email/troubleshooting/index.mdx b/pages/transactional-email/troubleshooting/index.mdx index dee4a40c20..2590fbaf29 100644 --- a/pages/transactional-email/troubleshooting/index.mdx +++ b/pages/transactional-email/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: TransactionalEmailProductIcon ## Featured Pages - - - - - - - - - - - \ No newline at end of file + diff --git a/pages/vpc/concepts.mdx b/pages/vpc/concepts.mdx index 515de31270..95e9f8d33a 100644 --- a/pages/vpc/concepts.mdx +++ b/pages/vpc/concepts.mdx @@ -12,6 +12,11 @@ dates: validation: 2025-05-05 posted: 2023-02-06 --- +import RegionAndAz from '@macros/console/region-and-az.mdx' + +import image from './assets/scaleway-vpc-pn-diag.webp' +import image2 from './assets/scaleway-vpc-osi.webp' + ## CIDR block @@ -111,7 +116,7 @@ While DHCP is built into all new Private Networks, it may not be automatically a ## Region and Availability Zone - + ## Route table @@ -148,10 +153,10 @@ A vRouter is a virtualized router that sits inside a VPC and manages layer 3 rou VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. Within each VPC, you can create **Private Networks** and attach Scaleway resources to them, as long as the resources are in an AZ within the network's region. - + VPC currently comprises the [Private Networks](#private-networks) product. Layer 2 Private Networks sit inside the layer 3 VPC. [VPC routing](#routing) allows traffic to be routed throughout the VPC. Find out more about [getting the most from your VPC and Private Networks](/vpc/reference-content/getting-most-private-networks/). - \ No newline at end of file + \ No newline at end of file diff --git a/pages/vpc/faq.mdx b/pages/vpc/faq.mdx index 9f216ac5df..bd8d125c8c 100644 --- a/pages/vpc/faq.mdx +++ b/pages/vpc/faq.mdx @@ -9,6 +9,8 @@ dates: category: network productIcon: VpcProductIcon --- +import image from './assets/scaleway-vpc-pn-diag.webp' + ## VPC basics @@ -16,7 +18,7 @@ productIcon: VpcProductIcon A VPC offers layer 3 network isolation. Within each VPC, you can create multiple **Private Networks** (layer 2) and attach Scaleway resources to them, as long as the resources are in an AZ within the network's region. Resources attached to a Private Network can then communicate between themselves in an isolated and secure network, away from the public internet. VPC routing facilitates communication between resources on the different Private Networks within the VPC. - + ### What is a default VPC and why can I not delete it? diff --git a/pages/vpc/how-to/activate-dhcp.mdx b/pages/vpc/how-to/activate-dhcp.mdx index 3e7ec26028..04f47dcbcb 100644 --- a/pages/vpc/how-to/activate-dhcp.mdx +++ b/pages/vpc/how-to/activate-dhcp.mdx @@ -12,6 +12,13 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-default-vpc.webp' +import image2 from './assets/scaleway-pns.webp' +import image3 from './assets/scaleway-activate-dhcp.webp' +import image4 from './assets/scaleway-activate-dhcp-modal.webp' + All Private Networks created after July 12 2023 have **DHCP built into them**. A CIDR block is defined when you create the Private Network. When a resource is attached to the Private Network, an IPv4 and IPv6 address is statically allocated to them from this block. This is all managed by our internal [IPAM](/vpc/concepts/#ipam) and removes the need for manual configuration of your IP addresses. @@ -29,7 +36,7 @@ We highly recommend activating DHCP on all of your Private Networks, to let us t Activating DHCP will overwrite any existing manually configured static IP addresses for resources attached to the network. Attached resources will receive new dynamically assigned private IP addresses (one IPv4 and one IPv6) from the network's pre-defined CIDR block. The CIDR block will be displayed at the time of activation (see step 5 below), and you will be able to [view your resources' newly assigned IP addresses](/vpc/how-to/attach-resources-to-pn/#how-to-view-the-resources-ip-address) after activation. These IP addresses do not risk changing unless you detach your resource from the Private Network. You can also use IPAM's [reserve an IP](/ipam/how-to/reserve-ip/) function to reserve a specific IP address, and use that when attaching your resource. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -39,21 +46,21 @@ Activating DHCP will overwrite any existing manually configured static IP addres 1. Click **VPC** in the **Network** section of the side menu. The following screen displays: - + 2. Click the VPC for the region that corresponds to your Private Network. A list of your Private Networks in this VPC displays. Private Networks that do not have DHCP activated have an **!** icon next to them. - + 3. Click the Private Network you want to activate DHCP on. The following banner displays: - + 4. Click **Activate DHCP** on the banner. The following screen displays: - + 5. Read the warning message carefully, and click **Activate DHCP** when you are ready. diff --git a/pages/vpc/how-to/attach-resources-to-pn.mdx b/pages/vpc/how-to/attach-resources-to-pn.mdx index 43097c216e..9e504c19ec 100644 --- a/pages/vpc/how-to/attach-resources-to-pn.mdx +++ b/pages/vpc/how-to/attach-resources-to-pn.mdx @@ -12,6 +12,14 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-pn-overview.webp' +import image2 from './assets/scaleway-pn-attached-resources.webp' +import image3 from './assets/scaleway-attach-resource.webp' +import image4 from './assets/scaleway-attach-custom.webp' +import image5 from './assets/scaleway-attached-resources.webp' + VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. Within each VPC, you can create multiple **Private Networks** and attach Scaleway resources to them, as long as the resources are in an AZ within the network's region. Attached resources can then communicate between themselves in an isolated and secure layer 2 network, away from the public internet. @@ -36,7 +44,7 @@ The following resource types can be attached to a Private Network: **Custom resources** - Custom resources with a MAC address, e.g. a VM hosted on an Elastic Metal server - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -55,11 +63,11 @@ The following resource types can be attached to a Private Network: The Private Network's dashboard displays. - + 4. Click the **Attached resources** tab. - + 5. Use the toggle to select the type of resource you want to attach: @@ -74,7 +82,7 @@ The following resource types can be attached to a Private Network: - + - From the first drop-down, select the **type** of managed resource (Instance, Elastic Metal server etc.) to attach. - From the second drop-down, select the **specific resource** of this type to attach. Only resources within the same region as the Private Network will be displayed. @@ -87,7 +95,7 @@ The following resource types can be attached to a Private Network: - + This method is intended for custom resources such as VMs hosted on Elastic Metal. Do **not** attempt to attach a managed resource, such as an Instance, via this method - use the **Managed resource** attachment instead. @@ -126,7 +134,7 @@ No matter whether it is auto-allocated or pre-reserved, the IP remains stable fo You can view a resource's IPv4 or v6 address in the **Attached Resources** tab of the Private Network itself (follow steps 1 - 5 above). - + It can also be viewed via the **Private Networks** tab of the resource's own dashboard. diff --git a/pages/vpc/how-to/create-private-network.mdx b/pages/vpc/how-to/create-private-network.mdx index 32eae2b812..5b10440666 100644 --- a/pages/vpc/how-to/create-private-network.mdx +++ b/pages/vpc/how-to/create-private-network.mdx @@ -12,6 +12,13 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import PnNaming from '@macros/vpc/pn-naming.mdx' + +import image from './assets/scaleway-create-a-pn.webp' +import image2 from './assets/scaleway-pn-advanced-settings.webp' +import image3 from './assets/scaleway-pn-define-custom.webp' + VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. Within each VPC, you can create multiple **Private Networks** and attach Scaleway resources to them, as long as the resources are in an AZ within the network's region. Attached resources can then communicate between themselves in an isolated and secure layer 2 network, away from the public internet. @@ -21,7 +28,7 @@ Private Networks also have built-in **D**ynamic **H**ost **C**onfiguration **P** While DHCP is built into all new Private Networks, it may not be automatically activated for Private Networks created before July 2023. Check our [migration](/vpc/reference-content/vpc-migration/) documentation for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -36,11 +43,11 @@ While DHCP is built into all new Private Networks, it may not be automatically a 3. Click **+ Create Private Network**. The creation screen displays. - + 4. Enter a **name** for the network, or leave the randomly generated name in place. Optionally, you can also add **tags** to help organize your Private Networks. Each tag should be separated by a space. - + 5. **Optional**: Click **Advanced Settings** to edit these settings, otherwise they will be left at default recommended values. The only advanced setting available concerns the creation of an IPv4 CIDR block for the Private Network, from which private IP addresses will be allocated. You cannot change the CIDR block after the Private Network has been created. See the section below on [configuring CIDR](#how-to-configure-cidr) for more help with choosing these settings. @@ -76,11 +83,11 @@ If you prefer, you can define your own custom IPv4 CIDR block when creating your 1. Follow the steps [above](#how-to-create-a-private-network) to create a Private Network, and at step 5, click **Advanced Settings**. - + 2. Click **Define custom**. The following screen displays: - + 3. Enter a network **prefix**. This should typically be in the following ranges normally used for private networks: - `192.168.0.0` - `192.168.255.255` diff --git a/pages/vpc/how-to/create-vpc.mdx b/pages/vpc/how-to/create-vpc.mdx index 79d43e2da8..92a26584a0 100644 --- a/pages/vpc/how-to/create-vpc.mdx +++ b/pages/vpc/how-to/create-vpc.mdx @@ -12,10 +12,17 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import NetworkResourceNaming from '@macros/vpc/network-resource-naming.mdx' + +import image from './assets/scaleway-default-vpc.webp' +import image2 from './assets/scaleway-create-vpc.webp' +import image3 from './assets/scaleway-vpc-overview.webp' + VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. Within each VPC, you can create **Private Networks** and attach Scaleway resources to them, as long as the resources are in an AZ within the network's region. Attached resources can then communicate between themselves in isolated and secured networks, away from the public internet. The [routing](/vpc/concepts/#routing) feature allows the different Private Networks of a VPC to communicate with each other. More features and resources will be coming to the VPC product in the future. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -28,7 +35,7 @@ If you created your Scaleway [Project](/organizations-and-projects/concepts/#pro Click **VPC** in the **Network** section of the Scaleway console side menu. Your VPC [dashboard](https://console.scaleway.com/vpc/vpc) displays: - + You see three default VPCs (each with a **DEFAULT** badge next to it), one for each of the following regions: @@ -50,13 +57,13 @@ If you created your Scaleway Project after 13 May 2025, default VPCs are no long 2. Click **Create a VPC**. The VPC creation wizard displays. - + 3. Choose a **region** in which to create your VPC. 4. Enter a **name** for your VPC (or use the wand icon to generate a random name). Optionally, you can also add **tags** to help organize your VPCs. Each tag should be separated by a space. - + You can create Private Networks in this VPC after you have created the VPC itself. However, you can not move an existing Private Network from one VPC to another. @@ -76,7 +83,7 @@ If you created your Scaleway Project after 13 May 2025, default VPCs are no long 4. Make the following edits as required: - + - Hover your mouse over the VPC's name at the top of the page, and click the icon that displays. Edit the name as required, and click when you're done. - Click into the box marked **Tags** and start typing. Hit the spacebar to create the tag. Click the **X** next to any tag to delete it. diff --git a/pages/vpc/how-to/delete-private-network.mdx b/pages/vpc/how-to/delete-private-network.mdx index dd81105128..3e539385b1 100644 --- a/pages/vpc/how-to/delete-private-network.mdx +++ b/pages/vpc/how-to/delete-private-network.mdx @@ -12,8 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-delete-pn.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -32,7 +36,7 @@ categories: 3. Click the icon next to the Private Network you want to delete, then click **Delete** on the pop-up menu. - + A screen displays asking you to confirm that you want to delete the network, and that you have detached all resources from it. diff --git a/pages/vpc/how-to/delete-vpc.mdx b/pages/vpc/how-to/delete-vpc.mdx index 64c16446e2..34d5751d73 100644 --- a/pages/vpc/how-to/delete-vpc.mdx +++ b/pages/vpc/how-to/delete-vpc.mdx @@ -12,8 +12,12 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-default-vpc.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -25,7 +29,7 @@ You can only delete VPCs that: 1. Click **VPC** in the **Network** section of the Scaleway console side menu. The list of your VPCs displays: - + 2. Either: - Click next to the VPC you want to delete, and select **Delete** from the drop-down menu, or diff --git a/pages/vpc/how-to/manage-routing.mdx b/pages/vpc/how-to/manage-routing.mdx index 63562a3ed2..71e0f897ef 100644 --- a/pages/vpc/how-to/manage-routing.mdx +++ b/pages/vpc/how-to/manage-routing.mdx @@ -12,12 +12,18 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-route-table.webp' +import image2 from './assets/scaleway-create-custom-route.webp' +import image3 from './assets/scaleway-route-not-found.webp' + Routing is used to manage and control the flow of traffic within a VPC. It tells the VPC where to send traffic trying to get to a specific destination IP address. Notably, it allows traffic to be automatically routed between resources attached to different Private Networks within the VPC, as well as along user-created custom routes. Read more about the VPC routing feature, including detailed explanations, usage considerations, limitations and best practices in our [dedicated reference content](/vpc/reference-content/understanding-routing/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -84,7 +90,7 @@ Your VPC's **route table** can be found in its **Routing** tab. The route table When your route table starts to populate, it will look something like this: - + For help with understanding the route table and how to read it, [refer to our documentation about route tables](/vpc/reference-content/understanding-routing/#route-table). @@ -177,7 +183,7 @@ Follow the steps below to define a custom route: 4. Click **Create route**. The custom route creation wizard displays. - + 5. Enter a **description** for your route, e.g. "Route to hosted VPN". @@ -208,7 +214,7 @@ Follow the steps below to define a custom route: If you delete a resource used as a next hop in a custom route, or detach it from the Private Network, the custom route will cease to function. A **Not found!** warning will display in the **Next hop** column for this route in the route table. - + To resolve this, you must either: diff --git a/pages/vpc/index.mdx b/pages/vpc/index.mdx index caeaffadfb..ece1351347 100644 --- a/pages/vpc/index.mdx +++ b/pages/vpc/index.mdx @@ -55,17 +55,17 @@ meta: ## Tutorials - - - \ No newline at end of file +/> diff --git a/pages/vpc/quickstart.mdx b/pages/vpc/quickstart.mdx index 33275fe83b..ae0ba16bfb 100644 --- a/pages/vpc/quickstart.mdx +++ b/pages/vpc/quickstart.mdx @@ -12,6 +12,22 @@ dates: categories: - network --- +import Requirements from '@macros/iam/requirements.mdx' +import NetworkResourceNaming from '@macros/vpc/network-resource-naming.mdx' +import PnNaming from '@macros/vpc/pn-naming.mdx' + +import image from './assets/scaleway-vpc-basics.webp' +import image2 from './assets/scaleway-create-vpc.webp' +import image3 from './assets/scaleway-create-pn.webp' +import image4 from './assets/scaleway-pn-overview.webp' +import image5 from './assets/scaleway-pn-attached-resources.webp' +import image6 from './assets/scaleway-attach-resource.webp' +import image7 from './assets/scaleway-attach-custom.webp' +import image8 from './assets/scaleway-route-table.webp' +import image9 from './assets/scaleway-default-vpc.webp' +import image10 from './assets/scaleway-pns.webp' +import image11 from './assets/scaleway-delete-pn.webp' + VPC allows you to build your own **V**irtual **P**rivate **C**loud on top of Scaleway's shared public cloud. You can create one or more VPCs in each Scaleway [region](/vpc/concepts/#region-and-availability-zone). @@ -21,7 +37,7 @@ Within each VPC, you can create **Private Networks** and attach Scaleway resourc Attach a **Public Gateway** to your VPC to give your resources controlled access to the public internet via the Private Network. - + This quickstart walks you through the process of getting started with Scaleway VPC. @@ -33,7 +49,7 @@ If you are looking for detailed guidance on constructing your private infrastruc Discover the VPC interface on the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) @@ -47,13 +63,13 @@ If you created your Scaleway [Project](/organizations-and-projects/concepts/#pro 2. Click **Create a VPC**. The VPC creation wizard displays. - + 3. Choose a **region** in which to create your VPC. 4. Enter a **name** for your VPC (or use the wand icon to generate a random name). Optionally, you can also add **tags** to help organize your VPCs. Each tag should be separated by a space. - + You can create Private Networks in this VPC after you have created the VPC itself. However, you can not move an existing Private Network from one VPC to another. @@ -73,11 +89,11 @@ You can create multiple Private Networks within each VPC. Resources attached to 3. Click **+ Create Private Network**. The creation screen displays. - + 4. Enter a **name** for the network, or leave the randomly-generated name in place. Optionally, you can also add **tags** to help organize your Private Networks. Each tag should be separated by a space. - + Leave the Advanced Settings at default values, to create a network with an auto-generated CIDR block. IP addresses for attached resources will come from this block. @@ -93,11 +109,11 @@ You can create multiple Private Networks within each VPC. Resources attached to The Private Network's dashboard displays. - + 4. Click the **Attached resources** tab. - + 5. Use the toggle to select the type of resource you want to attach: @@ -112,7 +128,7 @@ You can create multiple Private Networks within each VPC. Resources attached to - + - From the first drop-down, select the **type** of managed resource (Instance, Elastic Metal server etc.) to attach. - From the second drop-down, select the **specific resource** of this type to attach. Only resources within the same region as the Private Network will be displayed. @@ -125,7 +141,7 @@ You can create multiple Private Networks within each VPC. Resources attached to - + This method is intended for custom resources such as VMs hosted on Elastic Metal. Do **not** attempt to attach a managed resource, such as an Instance, via this method - use the **Managed resource** attachment instead. @@ -179,7 +195,7 @@ Your VPC’s route table can be found in its **Routing** tab. The route table sh When your route table starts to populate, it will look something like this: - + For help with understanding the route table, refer to our full [routing documentation](/vpc/reference-content/understanding-routing/). For guidance on creating custom routes, see the [routing how-to](/vpc/how-to/manage-routing/#how-to-create-a-custom-route). @@ -195,17 +211,17 @@ You must [detach](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-f Each Private Network exists within a VPC. - + 2. Click the VPC containing the Private Network you want to delete. A list of your Private Networks in this VPC displays: - + 3. Click the icon next to the Private Network you want to delete, then click **Delete** on the pop-up menu. - + A screen displays asking you to confirm that you want to delete the network. diff --git a/pages/vpc/reference-content/getting-most-private-networks.mdx b/pages/vpc/reference-content/getting-most-private-networks.mdx index 25fb4b949f..d841cd191c 100644 --- a/pages/vpc/reference-content/getting-most-private-networks.mdx +++ b/pages/vpc/reference-content/getting-most-private-networks.mdx @@ -12,6 +12,9 @@ dates: categories: - network --- +import image from './assets/scaleway-vpc-schema.webp' +import image2 from './assets/scaleway-routing-diag.webp' + This document sets out guidance, advice and best practices for building and optimizing your Scaleway VPCs and Private Networks. @@ -23,7 +26,7 @@ The VPC operates at the network layer (layer 3) of the OSI model, while Private VPCs and Private Networks are both **regional** resources. When you create a Private Network in a VPC, it is necessarily scoped to the same region as the VPC. Some Scaleway resources are also regional, others are zonal and scoped to a single Availability Zone (AZ). When attaching resources to a Private Network, you can attach resources from any AZ within the Private Network's region, allowing for example an Elastic Metal server in PAR-2 to communicate securely, away from the public internet, with an Instance in PAR-1 and a Managed Database in PAR-3. - + | Region | Availability Zones | |-------------------------|---------------------------| @@ -33,7 +36,7 @@ VPCs and Private Networks are both **regional** resources. When you create a Pri The [**VPC routing**](/vpc/concepts/#routing) feature allows for managed and custom routes between the Private Networks of a VPC, so resources on different Private Networks can communicate. - + ## Designing your network topology diff --git a/pages/vpc/reference-content/understanding-nacls.mdx b/pages/vpc/reference-content/understanding-nacls.mdx index 416104d5d7..57912a1e5f 100644 --- a/pages/vpc/reference-content/understanding-nacls.mdx +++ b/pages/vpc/reference-content/understanding-nacls.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import image from './assets/scaleway-nacl-diag-simple.webp' +import image2 from './assets/scaleway-nacl-diag-detail.webp' +import image3 from './assets/scaleway-nacl-example.webp' + NACLs are currently in Public Beta, and configurable only via the [VPC API](https://www.scaleway.com/en/developers/api/vpc/) and developer tools. This feature will be coming soon to the Scaleway console. @@ -27,7 +31,7 @@ Every Scaleway VPC has a Network ACL. In its initial state, it contains no rules When you start adding rules to your NACL, traffic flow is restricted between certain sources and destinations within the VPC, according to the rules you set. A default rule is added to the NACL, which dictates the action to take on traffic that does not match any rules in the list: it can either be **allowed** or **denied**. - + NACL rules are stateless, meaning that the state of connections is not tracked, and return traffic is not automatically allowed just because the outbound request was allowed. Explicit rules are required for each direction of traffic. @@ -39,7 +43,7 @@ The diagram below shows how a NACL allows an Instance on Private Network A to se However, an Instance on Private Network B is blocked from sending a packet to an Instance on Private Network A, because no specific rules allow it to do so, and the default rule is set to `Deny`. - + ## NACL rule configuration @@ -75,7 +79,7 @@ Nonetheless, you can choose to set your default rule to **Allow** if you wish. I The table below shows an example of a NACL for IPv4 traffic: - + - A number of TCP rules allow connections to the specific ports necessary for SSH, HTTP, and HTTPS traffic. These rules allow all IPv4 sources within the VPC to connect to these ports, for all IPv4 destinations. diff --git a/pages/vpc/reference-content/understanding-routing.mdx b/pages/vpc/reference-content/understanding-routing.mdx index 44d38e1dac..8059447d29 100644 --- a/pages/vpc/reference-content/understanding-routing.mdx +++ b/pages/vpc/reference-content/understanding-routing.mdx @@ -12,6 +12,10 @@ dates: categories: - network --- +import image from './assets/scaleway-routing-diag-custom.webp' +import image2 from './assets/scaleway-route-table.webp' +import image3 from './assets/scaleway-vpc-new-routing-ex.webp' + ## Overview @@ -30,11 +34,11 @@ The diagram below shows an example of how routing works across two Private Netwo - An Instance also on Private Network A can send a packet to an Instance on Private Network B, via the vRouter. - The same Instance on Private Network A can send a packet to an IP destination at the other end of the VPN hosted on Instance XYZ on Private Network B, thanks to a custom route. - + ## Route table - + Every VPC has an associated **route table**, used to manage and control the routing of traffic within the VPC. The routes within a route table tell the VPC where to send traffic trying to get to a specific destination IP address. One line in the route table corresponds to one route. A route consists of: @@ -135,7 +139,7 @@ The example below shows how to achieve the desired routing behavior for a custom #### Scenario - + Your VPC has three Private Networks using the following CIDR blocks: - `backend-net`: `10.0.0.0/24` diff --git a/pages/vpc/reference-content/use-case-basic.mdx b/pages/vpc/reference-content/use-case-basic.mdx index 4c11dd44f8..96fdb226b8 100644 --- a/pages/vpc/reference-content/use-case-basic.mdx +++ b/pages/vpc/reference-content/use-case-basic.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import image from './assets/scaleway-vpc-infra-1.webp' + Scaleway **V**irtual **P**rivate **C**loud (VPC) and the accompanying range of network products, are important building blocks within the Scaleway ecosystem. By creating your Scaleway resources within a carefully thought out VPC-based infrastructure, you can maximize security, resilience and efficiency. @@ -25,7 +27,7 @@ This is the first in a series of use cases designed to show you potentially inte The architecture diagram below shows the infrastructure for this use-case. - + This is a basic infrastructure to leverage VPC isolation: diff --git a/pages/vpc/reference-content/vpc-migration.mdx b/pages/vpc/reference-content/vpc-migration.mdx index 7baab2a1db..7edc4917d3 100644 --- a/pages/vpc/reference-content/vpc-migration.mdx +++ b/pages/vpc/reference-content/vpc-migration.mdx @@ -12,6 +12,8 @@ dates: categories: - network --- +import image from './assets/scaleway-gateway-mode.webp' + ## Overview @@ -117,7 +119,7 @@ You may have observed the following behavior when during the period directly fol You can tell whether your Public Gateway is in legacy mode or IPAM mode, by referring to the "mode" badge in the [listing of your Public Gateway in the Scaleway console](https://console.scaleway.com/public-gateway/public-gateways). - + Find out more about legacy gateways versus IPAM-mode gateways in our [IPAM concept documentation](/public-gateways/concepts/#ipam). diff --git a/pages/vpc/troubleshooting/cant-delete-vpc-pn.mdx b/pages/vpc/troubleshooting/cant-delete-vpc-pn.mdx index 8c8d3dca26..8eb4a18305 100644 --- a/pages/vpc/troubleshooting/cant-delete-vpc-pn.mdx +++ b/pages/vpc/troubleshooting/cant-delete-vpc-pn.mdx @@ -12,6 +12,11 @@ dates: categories: - network --- +import image from './assets/scaleway-vpc-pns.webp' +import image2 from './assets/scaleway-default-vpcs.webp' +import image3 from './assets/scaleway-pn-resources.webp' +import image4 from './assets/scaleway-ipam-release-ip.webp' + You may want to delete a Private Network or a VPC if you are reorganizing your infrastructure, cleaning up after tests, or if you want to delete a Scaleway [Project](/organizations-and-projects/concepts/#project) or account. @@ -45,7 +50,7 @@ The VPC must contain no Private Networks before you can delete it. **Ensure you have deleted all the Private Networks inside the VPC**. You can see how many Private Networks are in your [VPC listing](https://console.scaleway.com/vpc/vpc) in the Scaleway console. - + In order to successfully delete a Private Network, you must ensure no resources are attached to it, and there are no private IPs reserved within the network. See the [information below](#i-cant-delete-my-private-network) for full details. @@ -53,7 +58,7 @@ In order to successfully delete a Private Network, you must ensure no resources You can identify default VPCs by the **Default** badge in the VPC listing, even if you have changed the name of the VPC itself. - + ## I can't delete my Private Network @@ -72,7 +77,7 @@ The Private Network must have no attached or associated resources before you can **Ensure you have detached all resources from the Private Network**. In the Scaleway console, you can see how many resources are attached to each Private Network in each VPC's **Private Networks** tab. - + If there are still attached resources, you must [detach them](/vpc/how-to/attach-resources-to-pn/#how-to-detach-a-resource-from-a-private-network) before proceeding. @@ -80,5 +85,5 @@ The Private Network must have no attached or associated resources before you can - In the [IPAM section](https://console.scaleway.com/ipam/) of the Scaleway console, use the filters to select the region and VPC of your Private Network. If there are any private IPs reserved for the Private Network, release them. - + \ No newline at end of file diff --git a/pages/vpc/troubleshooting/index.mdx b/pages/vpc/troubleshooting/index.mdx index f18f91bb19..52b0aacabc 100644 --- a/pages/vpc/troubleshooting/index.mdx +++ b/pages/vpc/troubleshooting/index.mdx @@ -22,19 +22,19 @@ productIcon: VpcProductIcon ## Featured Pages - - - - - - + However, in some cases even after waiting, an IP address may not be set for your resource on the Private Network. Read on below to find out more about this problem, and how to solve it. diff --git a/pages/webhosting/how-to/configure-dns-webhosting.mdx b/pages/webhosting/how-to/configure-dns-webhosting.mdx index b9824f9d9d..cb2fe795db 100644 --- a/pages/webhosting/how-to/configure-dns-webhosting.mdx +++ b/pages/webhosting/how-to/configure-dns-webhosting.mdx @@ -12,10 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-dns-verification.webp' + To link your domain name with Web Hosting, you must update the DNS configuration of your domain name to use Scaleway's configuration. Once updated, you can verify the configuration to activate your Web Hosting plan. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -43,5 +47,5 @@ To link your domain name with Web Hosting, you must update the DNS configuration 5. After updating your DNS configuration, click **Verify domain**. This initiates the DNS verification process. - + Once the process has been completed, you will notice a green dot next to **DNS verification**. Your DNS is now configured and linked with your Web Hosting plan. \ No newline at end of file diff --git a/pages/webhosting/how-to/manage-databases.mdx b/pages/webhosting/how-to/manage-databases.mdx index befad94d86..2fedcfd4ac 100644 --- a/pages/webhosting/how-to/manage-databases.mdx +++ b/pages/webhosting/how-to/manage-databases.mdx @@ -12,11 +12,13 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + You can create and manage databases for your website and applications, including user creation and password updates directly from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/manage-email-accounts.mdx b/pages/webhosting/how-to/manage-email-accounts.mdx index 2cce08849d..2fa2453a31 100644 --- a/pages/webhosting/how-to/manage-email-accounts.mdx +++ b/pages/webhosting/how-to/manage-email-accounts.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + Send, receive, and store electronic messages through the internet. Email accounts can be accessed via POP3 and IMAP protocols and managed from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/manage-ftp-accounts.mdx b/pages/webhosting/how-to/manage-ftp-accounts.mdx index 14011f2ac8..e7f4078aee 100644 --- a/pages/webhosting/how-to/manage-ftp-accounts.mdx +++ b/pages/webhosting/how-to/manage-ftp-accounts.mdx @@ -12,12 +12,14 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + FTP (File Transfer Protocol) is used to tranfer data from your computer to your Web Hosting account and vice versa. This allows you to manage the content of your website. You can create and manage FTP accounts directly from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/manage-webhosting.mdx b/pages/webhosting/how-to/manage-webhosting.mdx index 7c8d717170..9c1d1b3634 100644 --- a/pages/webhosting/how-to/manage-webhosting.mdx +++ b/pages/webhosting/how-to/manage-webhosting.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + You can access the control panel for your Web Hosting from the Scaleway console to autonomously manage your Web Hosting plan. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/migrate-webhosting-plan.mdx b/pages/webhosting/how-to/migrate-webhosting-plan.mdx index 32005d5c78..b365089a7d 100644 --- a/pages/webhosting/how-to/migrate-webhosting-plan.mdx +++ b/pages/webhosting/how-to/migrate-webhosting-plan.mdx @@ -12,6 +12,10 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + +import image from './assets/scaleway-webhosting-migrate-console.webp' + You now have the option to migrate your Dedibox Web Hosting Cloud (powered by cPanel) to our cutting-edge web hosting service within the Scaleway ecosystem. This new platform offers an intuitive graphical interface to streamline your web hosting management. By making the move to this upgraded system, you'll continue to access all the features included in your current Dedibox Web Hosting Cloud plan, along with the latest updates and performance enhancements for an even better hosting experience. @@ -19,7 +23,7 @@ You now have the option to migrate your Dedibox Web Hosting Cloud (powered by cP If you are migrating from a **Web Hosting Classic** plan, refer to our documentation [Web Hosting Classic migration - Technical information](/webhosting/reference-content/classic-hosting-migration-information/) for further information. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -44,7 +48,7 @@ You now have the option to migrate your Dedibox Web Hosting Cloud (powered by cP 2. Click **Migrate** on the web hosting overview. This action will trigger a pop-up to appear. 3. Review the details related to your web hosting and click **Migrate** to automatically populate the migration information in the Scaleway console. You will be redirected to the Scaleway console. 4. The migration details for your web hosting will be shown. Make sure that you are within the [destination project](/organizations-and-projects/quickstart/) for your hosting. Then, proceed to click **Migrate your Web Hosting**. - + The migration process will be completed within two business days. diff --git a/pages/webhosting/how-to/order-dedicated-ip.mdx b/pages/webhosting/how-to/order-dedicated-ip.mdx index da9f543412..ca1ad57abc 100644 --- a/pages/webhosting/how-to/order-dedicated-ip.mdx +++ b/pages/webhosting/how-to/order-dedicated-ip.mdx @@ -12,6 +12,8 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + In shared Web Hosting, multiple websites share the same server and its resources. Each website typically has its own domain name, but they all use the same IP address for the server. Scaleway provides the option to purchase a dedicated IP address for your website, even within a shared hosting environment. @@ -26,7 +28,7 @@ Some potential advantages of having a dedicated IP address for Web Hosting are: Always assess your specific needs before deciding whether a dedicated IP is necessary for your shared hosting environment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/order-webhosting.mdx b/pages/webhosting/how-to/order-webhosting.mdx index e26a35a464..a315ef6ac5 100644 --- a/pages/webhosting/how-to/order-webhosting.mdx +++ b/pages/webhosting/how-to/order-webhosting.mdx @@ -12,10 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows how to create a Scaleway Web Hosting plan. Web Hosting is a managed service, designed for personal use, business use and everything in between. It allows you to host your website and databases and create personalized email addresses using your domain name. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/pages/webhosting/how-to/protect-webhosting.mdx b/pages/webhosting/how-to/protect-webhosting.mdx index 98be2d470f..7eef85591e 100644 --- a/pages/webhosting/how-to/protect-webhosting.mdx +++ b/pages/webhosting/how-to/protect-webhosting.mdx @@ -12,10 +12,12 @@ dates: categories: - web-hosting --- +import Requirements from '@macros/iam/requirements.mdx' + The [protected hosting](/webhosting/concepts/#protected-hosting) feature is designed to prevent any accidental or unauthorized deletions of your Web Hosting plan. When enabled, this feature ensures that your Web Hosting plan cannot be deleted, providing an extra layer of protection against unintended disruptions. This is particularly useful for preventing errors, such as accidental cancellations during routine maintenance or management activities. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions within the intended Organization diff --git a/pages/webhosting/how-to/terminate-webhosting.mdx b/pages/webhosting/how-to/terminate-webhosting.mdx index 917bf9759b..c90e457580 100644 --- a/pages/webhosting/how-to/terminate-webhosting.mdx +++ b/pages/webhosting/how-to/terminate-webhosting.mdx @@ -12,8 +12,12 @@ dates: categories: - managed-services --- +import Requirements from '@macros/iam/requirements.mdx' - +import image from './assets/scaleway-webhosting-terminate.webp' + + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - [Registered a domain name](/domains-and-dns/how-to/register-internal-domain/) at Scaleway or another registrar @@ -24,7 +28,7 @@ categories: 1. In the **Domains & Web Hosting** section of the [console](https://console.scaleway.com/) side menu, click **Web Hosting**. The **Web Hosting** overview page will display. 2. Click the **More options** icon () or the domain name of the Web Hosting plan you want to terminate. The **Hosting information** page will display. 3. Scroll down to the **Terminate Web Hosting** section and click **Terminate**. A pop-up will display. - + 4. Type **TERMINATE** in the confirmation field and click **Terminate Web Hosting** to confirm the termination. This action is irreversible and will permanently delete your Web Hosting account. All your data (files and emails) will be lost. diff --git a/pages/webhosting/quickstart.mdx b/pages/webhosting/quickstart.mdx index f238fc09f3..fb183b8612 100644 --- a/pages/webhosting/quickstart.mdx +++ b/pages/webhosting/quickstart.mdx @@ -12,6 +12,20 @@ dates: categories: - webhosting --- +import image from './assets/scaleway-webhosting-control-panel-dashboard.webp' +import image2 from './assets/scaleway-cpanel-language1.webp' +import image3 from './assets/scaleway-cpanel-language2.webp' +import image4 from './assets/scaleway-cpanel-language3.webp' +import image5 from './assets/scaleway-cpanel-login1.webp' +import image6 from './assets/scaleway-cpanel-login2.webp' +import image7 from './assets/scaleway-cpanel-email.webp' +import image8 from './assets/scaleway-cpanel-email-create.webp' +import image9 from './assets/scaleway-cpanel-email-create-form.webp' +import image10 from './assets/scaleway-email-created.webp' +import image11 from './assets/scaleway-webmail.webp' +import image12 from './assets/scaleway-cpanel-filemanager.webp' +import image13 from './assets/scaleway-cpanel-filemanager-view.webp' + Web Hosting is a service that allows individuals and organizations to make their website accessible on the internet. It involves storing website files and data on a server, which is connected to the internet and enables users to access the website through a web browser. @@ -50,7 +64,7 @@ Scaleway provides Web Hosting plans with the [cPanel](/webhosting/reference-cont 1. Click **Web Hosting** in the **Domains & Web Hosting** section of the [console](https://console.scaleway.com/) side menu. The **Web Hosting** overview page displays. 2. Click and **More info**, or the domain name of the Web Hosting plan you want to configure. The **Overview** tab displays information about your Web Hosting, such as your credentials to access cPanel. 3. Click **Open control panel** in the **Hosting information** section of the page. The Web Hosting control panel opens in a new tab. - + Retrieve your username under **Main user name** in the **Hosting information** section and your password in the **Initial password** section. @@ -62,11 +76,11 @@ Scaleway's Web Hosting control panel is a multi-language solution and you can sw 1. Open the [Web Hosting control panel](#how-to-access-the-web-hosting-control-panel-from-the-scaleway-console). The login screen displays. 2. Click `...` on the right below the login form to open a list of all available languages. - + 3. Click the language of your choice from the pop-up. A notification displays. - + 4. Log in using your credentials to use the control panel in your preferred language. - + ## First connection to the Web Hosting control panel @@ -74,9 +88,9 @@ Scaleway's Web Hosting control panel is a multi-language solution and you can sw 1. Open the [cPanel control panel](#how-to-access-the-web-hosting-control-panel-from-the-scaleway-console). The login screen displays. 2. Enter your **user** and the **temporary password** from the mail you have received after account creation. - + 3. Enter your **temporary password** as well as your **new password** and it's confirmation. A secret password with a score of 65/100 or more is required for the new password. - + You can use the **Password generator** to generate a safe random password. @@ -103,9 +117,9 @@ Scaleway's Web Hosting control panel is a multi-language solution and you can sw 1. Open the [Web Hosting control panel](#how-to-access-the-web-hosting-control-panel-from-the-scaleway-console) and log in using your panel user and password. The Web Hosting panel dashboard displays. 2. Click **Email accounts** in the **Email** section of the dashboard. A list of your mailboxes displays. - + 3. Click **+ Create** on the email account overview page. - + 4. Enter the email user name (first part of the email address before the "@" sign). 5. In the Password section: * Choose **Set password now** and input a secure password (not a dictionary word), including uppercase and lowercase letters, numbers, and symbols. @@ -115,9 +129,9 @@ Scaleway's Web Hosting control panel is a multi-language solution and you can sw * Click **Generate** to create a random secure password and reveal it. * Alternatively, select **Send login link to alternate email address** and input an email to receive a password creation link. - + 6. Click **+ Create** to create the email mailbox. You are being redirected and your new email mailbox displays in the list of email accounts: - + @@ -136,7 +150,7 @@ You can access the webmail platform for your Web Hosting directly from your Scal 1. Click **Web Hosting** in the **Domains & Web Hosting** section of the [console](https://console.scaleway.com/) side menu. The **Web Hosting** overview page displays. 2. Click and **More info**, or the domain name of the Web Hosting plan you want to configure. The **Hosting information** page displays. 3. Click on the link next to **Link to Webmail** in the **Hosting information** tab of your Web Hosting plan to access the webmail interface in a new browser tab. - + The address of the webmail for your Web Hosting may be different. Always use the link provided for your Web Hosting plan. @@ -152,10 +166,10 @@ You can access the webmail platform for your Web Hosting directly from your Scal 1. Open the [Web Hosting control panel](#how-to-access-the-web-hosting-control-panel-from-the-scaleway-console) and log in using your panel user and password. The Web Hosting panel dashboard displays. 2. Click **File Manager** in the **Files** section of the dashboard. - + The file manager displays. 3. Navigate to the `public_html` directory to upload, modify, or download your Web Hosting data. - + * For more information on how to use the file manager, refer to the official [File Manager documentation](https://docs.cpanel.net/cpanel/files/file-manager/) * You can also access your Web Hosting data via FTP by creating [FTP accounts](https://docs.cpanel.net/cpanel/files/ftp-accounts/) diff --git a/pages/webhosting/troubleshooting/index.mdx b/pages/webhosting/troubleshooting/index.mdx index a15e9e4ce9..e57ad3d98c 100644 --- a/pages/webhosting/troubleshooting/index.mdx +++ b/pages/webhosting/troubleshooting/index.mdx @@ -20,19 +20,19 @@ productIcon: WebhostingProductIcon ## Featured pages - - - - - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/access-mac-mini-with-reemo/index.mdx b/tutorials/access-mac-mini-with-reemo/index.mdx index b180e0f883..8d3eceedb2 100644 --- a/tutorials/access-mac-mini-with-reemo/index.mdx +++ b/tutorials/access-mac-mini-with-reemo/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-30 posted: 2022-02-18 --- +import Requirements from '@macros/iam/requirements.mdx' + Reemo is an ultra-low latency, high-performance desktop platform designed to allow anyone to connect to any computer and virtual environment from a Chrome browser to work and play freely from anywhere, on any device. Reemo works perfectly on macOS, Linux, and Windows and supports multiple peripherals. @@ -25,7 +27,7 @@ In this tutorial, you will learn how to launch your Mac mini development environ Reemo is a startup that was part of the [Scaleway Startup Program](https://www.scaleway.com/en/startup-program/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/actility-lorawan-operator/index.mdx b/tutorials/actility-lorawan-operator/index.mdx index 1de2b6b178..93cd461217 100644 --- a/tutorials/actility-lorawan-operator/index.mdx +++ b/tutorials/actility-lorawan-operator/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2020-07-02 --- +import Requirements from '@macros/iam/requirements.mdx' + LoRaWAN© stands out as a low-power, low-bandwidth, long-range radio protocol, ideal for wirelessly transmitting data from numerous devices. It is tailored for battery-operated gadgets, requiring minimal installation expenses. @@ -26,7 +28,7 @@ This tutorial will guide you through: - Configuring the Actility backend to use device credentials for establishing a connection with the IoT Hub. - Introducing another device and linking it as a subscriber to receive LoRaWAN© messages. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/add-disk-configure-datastore-esxi/index.mdx b/tutorials/add-disk-configure-datastore-esxi/index.mdx index 1f5dbe1a8e..b01f746050 100644 --- a/tutorials/add-disk-configure-datastore-esxi/index.mdx +++ b/tutorials/add-disk-configure-datastore-esxi/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2020-01-21 --- +import Requirements from '@macros/iam/requirements.mdx' + Due to VMware's acquisition by Broadcom, the free edition of VMware vSphere Hypervisor is no longer available on the VMware website. For more details, check out [the EOL of free vSphere Hypervisor](https://knowledge.broadcom.com/external/article?legacyId=2107518). The following content is provided as-is, without any guarantee of functionality. @@ -32,7 +34,7 @@ This guide is designed to walk you through the process of ordering an additional Instead of adding additional disks to your server, you can also use remote storage based on our RPN-SAN service to add another storage capacity to your ESXi host. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/ansible-bionic-beaver/index.mdx b/tutorials/ansible-bionic-beaver/index.mdx index 7879ed4700..5e110f2212 100644 --- a/tutorials/ansible-bionic-beaver/index.mdx +++ b/tutorials/ansible-bionic-beaver/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2018-07-26 --- +import Requirements from '@macros/iam/requirements.mdx' + Ansible is an IT automation tool. It simplifies cloud computing, configuration management, program setup, intra-service orchestration, and several other IT needs. @@ -21,7 +23,7 @@ While there are many popular configuration management systems available for Linu Ansible works by configuring client machines from a computer that has the Ansible components installed and configured. It communicates over standard SSH channels to retrieve information from remote machines. This means that any computer that you can administer through SSH, you can also administer through Ansible. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/ansible-galaxy/index.mdx b/tutorials/ansible-galaxy/index.mdx index 0635c9c096..7fe59eace1 100644 --- a/tutorials/ansible-galaxy/index.mdx +++ b/tutorials/ansible-galaxy/index.mdx @@ -13,13 +13,15 @@ dates: validation: 2025-03-25 posted: 2018-08-02 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, we show you how to use Ansible Galaxy. Ansible Galaxy is a tool that seeks to give visibility to one of Ansible's most exciting features: reusable roles for server configuration or the installation of applications. Many users share roles on [Ansible Galaxy](https://galaxy.ansible.com/home). Ansible roles consist of playbooks that group multiple tasks into one container. They allow the performance of automation tasks with clean directory structures. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/ark-server/index.mdx b/tutorials/ark-server/index.mdx index b404a19992..719540130f 100644 --- a/tutorials/ark-server/index.mdx +++ b/tutorials/ark-server/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2020-11-10 --- +import Requirements from '@macros/iam/requirements.mdx' + [ARK: Survival Evolved](https://fr.wikipedia.org/wiki/ARK:_Survival_Evolved) is an action-adventure game released in 2017 by the game development company Studio Wildcard. The game is available for PC, Xbox One, Nintendo Switch, and PS4. Mobile versions of the game exist for Android and iOS. @@ -36,7 +38,7 @@ In this tutorial, you will learn how to create an ARK server on a [Scaleway Inst ## How can I create an ARK server? - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/arqbackup-pc-mac/index.mdx b/tutorials/arqbackup-pc-mac/index.mdx index 201f59f295..d51d0edb5d 100644 --- a/tutorials/arqbackup-pc-mac/index.mdx +++ b/tutorials/arqbackup-pc-mac/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-03-27 posted: 2019-07-20 --- +import Requirements from '@macros/iam/requirements.mdx' + Arq Backup automatically backs up Macs and PCs to cloud storage while encrypting the data in an [open and documented format](https://www.arqbackup.com/arq_data_format.txt). This tutorial guides you through backing up your PC or Mac computer to Scaleway Object Storage using Arq Backup version 7. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/automate-tasks-using-cron/index.mdx b/tutorials/automate-tasks-using-cron/index.mdx index a3770e300f..f1d36ee6f4 100644 --- a/tutorials/automate-tasks-using-cron/index.mdx +++ b/tutorials/automate-tasks-using-cron/index.mdx @@ -13,11 +13,13 @@ dates: validation: 2025-03-27 posted: 2019-11-09 --- +import Requirements from '@macros/iam/requirements.mdx' + Cron serves as the silent orchestrator behind the scenes on Unix-like systems like Ubuntu Linux 20.04 LTS (Focal Fossa), dutifully executing scheduled commands stored within the Crontab structure. These scheduled tasks, fondly called Cronjobs, work tirelessly to automate routine maintenance chores, streamlining machine administration with their autonomous operation. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/back-up-postgresql-barman/index.mdx b/tutorials/back-up-postgresql-barman/index.mdx index 035856cd5f..20057bf6bc 100644 --- a/tutorials/back-up-postgresql-barman/index.mdx +++ b/tutorials/back-up-postgresql-barman/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2018-08-29 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/backup-dedicated-server-s3-duplicity/index.mdx b/tutorials/backup-dedicated-server-s3-duplicity/index.mdx index 00dd7a5d02..b20a4f4ca6 100644 --- a/tutorials/backup-dedicated-server-s3-duplicity/index.mdx +++ b/tutorials/backup-dedicated-server-s3-duplicity/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-24 posted: 2018-10-13 --- +import Requirements from '@macros/iam/requirements.mdx' + In this article, we will learn how to back up data from a Scaleway Instance, using [Scaleway's Object Storage](/object-storage/quickstart/) service and Duplicity. [Duplicity](https://duplicity.gitlab.io/) is a free and open-source tool that backs up folders to a remote server, in this case, an Object Storage bucket. Using libsync and GPG, Duplicity can make space-efficient encrypted backups. @@ -30,7 +32,7 @@ To achieve this, we will: Although this tutorial focuses on backing up an Instance, you can also back up a dedicated server with Duplicity. When you are using a [Scaleway Dedibox](https://www.scaleway.com/fr/dedibox/) or a [Scaleway Elastic Metal server](https://www.scaleway.com/en/elastic-metal/), the data transfer is free of charge within the same region. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/backup-mongodb-jobs/index.mdx b/tutorials/backup-mongodb-jobs/index.mdx index 719ab28170..6321677e25 100644 --- a/tutorials/backup-mongodb-jobs/index.mdx +++ b/tutorials/backup-mongodb-jobs/index.mdx @@ -13,11 +13,13 @@ dates: validation: 2025-06-17 posted: 2025-06-17 --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of creating snapshots of a [Scaleway Managed MongoDB® database](/managed-mongodb-databases/quickstart/) on a recurring schedule using a Serverless Job. Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/tutorials/backup-postgresql-pgbackrest-s3/index.mdx b/tutorials/backup-postgresql-pgbackrest-s3/index.mdx index 00319923fc..21c6bf4731 100644 --- a/tutorials/backup-postgresql-pgbackrest-s3/index.mdx +++ b/tutorials/backup-postgresql-pgbackrest-s3/index.mdx @@ -12,6 +12,8 @@ categories: - object-storage - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + pgBackRest aims to be a reliable, easy-to-use backup and restore solution that can seamlessly scale up to the largest databases and workloads by utilizing algorithms that are optimized for database-specific requirements. @@ -20,7 +22,7 @@ pgBackRest can back up in three ways: - **Differential backup**: This only retrieves files that have changed since the last full backup. Both the full backup and the differential backup must be intact. - **Incremental backup**: This retrieves files that have changed since the last backup. The last backup can be a full backup or a differential backup. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/backup-synology-nas-s3-hyper-backup/index.mdx b/tutorials/backup-synology-nas-s3-hyper-backup/index.mdx index 6e3b880138..4d573ca3d9 100644 --- a/tutorials/backup-synology-nas-s3-hyper-backup/index.mdx +++ b/tutorials/backup-synology-nas-s3-hyper-backup/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-09 posted: 2019-12-03 --- +import Requirements from '@macros/iam/requirements.mdx' + [Synology Hyper Backup](https://www.synology.com/en-us/dsm/feature/hyper_backup) is a solution to back up your Synology NAS easily on Scaleway Object Storage. @@ -20,7 +22,7 @@ A NAS is a network-connected device housing one or several hard disks to store a As the NAS holds huge amounts of your personal data, a good backup strategy is important. Synology has developed an application called Hyper Backup which allows automatizing the backup of their NAS devices on several external media. These media include external devices, another Synology NAS, a rsync server, or a public cloud service like [Scaleway Object Storage](https://www.scaleway.com/en/object-storage/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/bind-dns-server/index.mdx b/tutorials/bind-dns-server/index.mdx index 347146942e..992e63d0e7 100644 --- a/tutorials/bind-dns-server/index.mdx +++ b/tutorials/bind-dns-server/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-05-27 posted: 2018-12-05 --- +import Requirements from '@macros/iam/requirements.mdx' + DNS (Domain Name System) is a service that translates the IP address of computers connected to the internet into human-readable domain names, and vice versa. In an environment with a limited amount of Linux machines, it is possible to use the `/etc/hosts` file for associating an IP address to a DNS name. But when you have a large infrastructure with lots of systems/resources, `/etc/hosts` may quickly become cumbersome. [BIND](https://www.isc.org/bind/) or Berkeley Internet Name Domain is open-source software that implements DNS protocols for the internet. In this tutorial, we need primary and secondary DNS server machines, in accordance with best practice to ensure redundancy. We also need a third machine (e.g. your local machine) for testing. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/building-ai-application-function-calling/index.mdx b/tutorials/building-ai-application-function-calling/index.mdx index 94a81fc568..1ca75a5af0 100644 --- a/tutorials/building-ai-application-function-calling/index.mdx +++ b/tutorials/building-ai-application-function-calling/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-05-19 posted: 2024-10-25 --- +import Requirements from '@macros/iam/requirements.mdx' + In today's AI-driven world, enabling natural language interactions with structured data systems has become increasingly important. Function calling allows AI models like Llama 3.1 to bridge the gap between human queries and programmatic functions, creating powerful agents for many use cases. This tutorial will guide you through creating a simple flight schedule assistant that can understand natural language queries about flights and return structured information. We will use Python and the OpenAI SDK to implement function calling on Llama 3.1, making it easy to integrate this solution into your existing applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Python 3.7 or higher diff --git a/tutorials/ceph-cluster/index.mdx b/tutorials/ceph-cluster/index.mdx index df4612b766..e41358d88a 100644 --- a/tutorials/ceph-cluster/index.mdx +++ b/tutorials/ceph-cluster/index.mdx @@ -15,11 +15,13 @@ dates: validation_frequency: 18 posted: 2020-06-29 --- +import Requirements from '@macros/iam/requirements.mdx' + Ceph is an open-source, software-defined storage solution that provides object, block, and file storage at exabyte scale. It is self-healing, self-managing, and fault-tolerant, using commodity hardware to minimize costs. This tutorial guides you through deploying a three-node Ceph cluster with a RADOS Gateway (RGW) for S3-compatible object storage on Dedibox dedicated servers running Ubuntu 24.04 LTS. - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/cicd-github-action-object-storage-sync/index.mdx b/tutorials/cicd-github-action-object-storage-sync/index.mdx index eedd9ca332..16befbefe6 100644 --- a/tutorials/cicd-github-action-object-storage-sync/index.mdx +++ b/tutorials/cicd-github-action-object-storage-sync/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-03-10 posted: 2025-03-10 --- +import Requirements from '@macros/iam/requirements.mdx' + Deploying your content to Scaleway Object Storage Using GitHub Actions This tutorial will guide you through setting up a GitHub Action to deploy your Astro site to Scaleway Object Storage. We will use a GitHub Actions workflow to automate the deployment process whenever changes are pushed to the `main` branch. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [GitHub](https://github.com/) repository with your [Astro](https://astro.build/) project. diff --git a/tutorials/cilicon-self-hosted-ci-on-apple-silicon/index.mdx b/tutorials/cilicon-self-hosted-ci-on-apple-silicon/index.mdx index 36b92b7abe..d33c18f96a 100644 --- a/tutorials/cilicon-self-hosted-ci-on-apple-silicon/index.mdx +++ b/tutorials/cilicon-self-hosted-ci-on-apple-silicon/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2024-12-24 posted: 2023-12-14 --- +import Requirements from '@macros/iam/requirements.mdx' + Cilicon, a macOS application developed by Trade Republic, uses Apple's Virtualization Framework to create, allocate, and execute ephemeral CI (Continuous Integration) virtual machines with near-native performance. The underlying concept of Cilicon follows a simple cycle: @@ -29,7 +31,7 @@ Cilicon, a macOS application developed by Trade Republic, uses Apple's Virtualiz Cilicon uses the tart container format and integrates an OCI client to fetch images from the internet. The tool currently supports GitHub Actions, Buildkite Agent, GitLab Runner, and arbitrary scripts. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Mac mini](/apple-silicon/how-to/create-mac-mini/) diff --git a/tutorials/collecting-visualizing-logs-elastic-stack/index.mdx b/tutorials/collecting-visualizing-logs-elastic-stack/index.mdx index c75dda7506..53de6c74e4 100644 --- a/tutorials/collecting-visualizing-logs-elastic-stack/index.mdx +++ b/tutorials/collecting-visualizing-logs-elastic-stack/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-03-06 posted: 2015-06-10 --- +import Requirements from '@macros/iam/requirements.mdx' + The Elastic Stack, formerly known as the ELK Stack, is a powerful suite of open-source tools designed for real-time data search, analysis, and visualization. It offers comprehensive capabilities for collecting, processing, and visualizing large volumes of data. Its components are: @@ -22,7 +24,7 @@ The Elastic Stack, formerly known as the ELK Stack, is a powerful suite of open- - **[Kibana](https://www.elastic.co/kibana)**: A visualization and exploration tool for analyzing and visualizing data stored in Elasticsearch. - **[Beats](https://www.elastic.co/beats/)**: Lightweight data shippers for ingesting data into Elasticsearch or Logstash. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-apache-kafka/index.mdx b/tutorials/configure-apache-kafka/index.mdx index 464d56fc7e..81a8e029df 100644 --- a/tutorials/configure-apache-kafka/index.mdx +++ b/tutorials/configure-apache-kafka/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-26 posted: 2018-04-07 --- +import Requirements from '@macros/iam/requirements.mdx' + [Apache Kafka](https://kafka.apache.org) is a versatile distributed messaging system, developed initially by LinkedIn to handle their growing need for message processing. It is a publish/subscribe messaging system that has an interface typical of messaging systems but a storage layer more like a log-aggregation system and can be used for various activities, from monitoring (collection of metrics, or the creation of dashboards), messaging (used for message queues in content feeds), activity tracking (from passive information like page views or clicks to more complex data like user-generated content) or a building block for distributed applications (distributed databases, distributed log systems). @@ -20,7 +22,7 @@ The project started in 2010 at LinkedIn and was released to the open-source comm Kafka has been implemented by many companies of any size because of its flexibility, immense scalability (you can grow your Kafka cluster by adding additional brokers without any impact on the system and handle trillions of messages), and redundancy. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-apache-lets-encrypt/index.mdx b/tutorials/configure-apache-lets-encrypt/index.mdx index 9325a9c0f2..24241b1b94 100644 --- a/tutorials/configure-apache-lets-encrypt/index.mdx +++ b/tutorials/configure-apache-lets-encrypt/index.mdx @@ -13,13 +13,15 @@ dates: validation: 2025-04-08 posted: 2019-05-23 --- +import Requirements from '@macros/iam/requirements.mdx' + Let's Encrypt is a certificate authority providing free SSL certificates. The creation, validation, and installation are automated with Certbot — all major browsers trust certificates issued by Let's Encrypt. In this tutorial, you will discover how to secure your Apache web server on a Scaleway Instance running Ubuntu Linux. We will walk you through the process of setting up a website on Apache and obtaining a Let's Encrypt SSL certificate using Certbot. Let's dive in and make your web presence safer and more trustworthy. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-chef-ubuntu-xenial/index.mdx b/tutorials/configure-chef-ubuntu-xenial/index.mdx index 4e32350533..7cd72370bd 100644 --- a/tutorials/configure-chef-ubuntu-xenial/index.mdx +++ b/tutorials/configure-chef-ubuntu-xenial/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-14 posted: 2018-07-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Chef is a configuration management tool that is written in Ruby and Erlang. It is capable of managing both your on-premise machines and your Scaleway resources with ease. @@ -19,7 +21,7 @@ As your infrastructure requirements grow, managing each server individually beco You can easily manage up to 10,000 nodes using Chef. Chef also makes it easy to automate the replication of infrastructure components. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-dvc-with-object-storage/index.mdx b/tutorials/configure-dvc-with-object-storage/index.mdx index 9a8bdb9383..39a6a78687 100644 --- a/tutorials/configure-dvc-with-object-storage/index.mdx +++ b/tutorials/configure-dvc-with-object-storage/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-26 posted: 2023-06-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Git is unarguably the most popular and powerful version control system to store your code and can handle files of up to 5 GB thanks to Git LFS. @@ -21,7 +23,7 @@ Data Version Control (DVC) was specifically designed with this use case in mind. In this tutorial, you learn how to use [Scaleway Object Storage](https://www.scaleway.com/en/object-storage/) as a remote storage for DVC. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-failover-proxmox/index.mdx b/tutorials/configure-failover-proxmox/index.mdx index 1639be2b83..d8d325e6db 100644 --- a/tutorials/configure-failover-proxmox/index.mdx +++ b/tutorials/configure-failover-proxmox/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-05-12 posted: 2020-01-23 --- +import Requirements from '@macros/iam/requirements.mdx' + Proxmox Virtual Environment (Proxmox VE) is an open-source management platform for virtual machines, based on Debian Linux. It integrates both, [Linux Kernel Virtual Machines (KVM)](https://www.linux-kvm.org/page/Main_Page) and [LXC containers](https://linuxcontainers.org/). KVM provides full virtualization for complete Windows and Linux images whilst LXC containers are lightweight and perfect to run conflict-free Linux applications. [Proxmox Virtual Environment](https://www.proxmox.com/en/) is an alternative hypervisor to [VMware ESXi](/tutorials/configure-virtual-machine-esxi/) or [Microsoft HyperV](/tutorials/configure-vm-hyperv/). You can easily host Virtual Machines (VM) on a dedicated server. The software provides an intuitive web interface as well as a complete REST-API to deploy and manage infrastructures. - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-graphite/index.mdx b/tutorials/configure-graphite/index.mdx index 7b1a30de4a..a7e3367bfc 100644 --- a/tutorials/configure-graphite/index.mdx +++ b/tutorials/configure-graphite/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-03-06 posted: 2018-08-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Graphite is a popular tool for monitoring and visualizing time-series data. It performs two main functions: @@ -22,7 +24,7 @@ Graphite is a popular tool for monitoring and visualizing time-series data. It p This tutorial provides the steps needed to install and configure Graphite on **Ubuntu 22.04** and get started with monitoring and visualizing your metrics. - + - A **Scaleway account** logged into the [console](https://console.scaleway.com) - **Owner** status or **IAM permissions** that allow performing actions in the intended Organization diff --git a/tutorials/configure-ipv6-virtual-machine-esxi/index.mdx b/tutorials/configure-ipv6-virtual-machine-esxi/index.mdx index 7b993d8cbc..68097fdacd 100644 --- a/tutorials/configure-ipv6-virtual-machine-esxi/index.mdx +++ b/tutorials/configure-ipv6-virtual-machine-esxi/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-12 posted: 2022-02-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Due to VMware's acquisition by Broadcom, the free edition of **VMware vSphere Hypervisor is no longer available** on the VMware website. For more details, check out [the EOL of free vSphere Hypervisor](https://knowledge.broadcom.com/external/article?legacyId=2107518). Please note that the following content is provided as-is, without any guarantee of functionality @@ -20,7 +22,7 @@ dates: This tutorial explains how to configure IPv6 on virtual machines on ESXi hypervisors. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-nagios-monitoring/index.mdx b/tutorials/configure-nagios-monitoring/index.mdx index 316e7b10ed..dd8fa8582b 100644 --- a/tutorials/configure-nagios-monitoring/index.mdx +++ b/tutorials/configure-nagios-monitoring/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-04-01 posted: 2018-06-19 --- +import Requirements from '@macros/iam/requirements.mdx' + Monitoring your resources is an indispensable building block for the success of your SaaS or e-commerce application. An unnoticed system failure can have serious financial consequences and negatively impact your image. Therefore, you will learn by following this tutorial how to install and configure a [Nagios](https://www.nagios.org/) monitoring application with an Apache web server to monitor your servers. It is an open-source monitoring system that can automatically alert you in case of a server dysfunction. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-netbox-managed-postgresql-database/index.mdx b/tutorials/configure-netbox-managed-postgresql-database/index.mdx index 6688de5c24..9bf2f5d620 100644 --- a/tutorials/configure-netbox-managed-postgresql-database/index.mdx +++ b/tutorials/configure-netbox-managed-postgresql-database/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-14 posted: 2019-11-14 --- +import Requirements from '@macros/iam/requirements.mdx' + NetBox is a web application designed and built to help manage and document large computer networks. It is designed for IP address management (IPAM) and data center infrastructure management (DCIM). The application runs as a web application based on the Django Python framework and uses a PostgreSQL database to store information. The open-source software was developed specifically with the needs of network and infrastructure engineers in mind. In this tutorial, you learn how to install and configure NetBox on an Instance running on Ubuntu 20.04 LTS and a Database for PostgreSQL. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-nextcloud-ubuntu/index.mdx b/tutorials/configure-nextcloud-ubuntu/index.mdx index 0c215a8e95..060dbf7036 100644 --- a/tutorials/configure-nextcloud-ubuntu/index.mdx +++ b/tutorials/configure-nextcloud-ubuntu/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-05-14 posted: 2018-10-26 --- +import Requirements from '@macros/iam/requirements.mdx' + Nextcloud is an open-source, self-hosted file share, and communication platform. It provides a large portfolio of [different applications](https://nextcloud.com/install/#install-clients) to access your cloud storage from your PC, Mac, or mobile device. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-nginx-lets-encrypt/index.mdx b/tutorials/configure-nginx-lets-encrypt/index.mdx index 12ceaae973..f5c88959e3 100644 --- a/tutorials/configure-nginx-lets-encrypt/index.mdx +++ b/tutorials/configure-nginx-lets-encrypt/index.mdx @@ -12,11 +12,13 @@ dates: validation: 2025-05-19 posted: 2019-02-28 --- +import Requirements from '@macros/iam/requirements.mdx' + Let's Encrypt, a renowned Certificate Authority (CA), offers a valuable service by providing free TLS/SSL certificates. These certificates are a key element in enabling secure HTTPS connections on web servers. Let's Encrypt simplifies the process through its user-friendly software client, Certbot, which automates the majority of the steps involved in obtaining and configuring certificates, particularly within the Nginx web server environment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-nodemcu-iot-hub/index.mdx b/tutorials/configure-nodemcu-iot-hub/index.mdx index 83ba8e13b4..8524904dc7 100644 --- a/tutorials/configure-nodemcu-iot-hub/index.mdx +++ b/tutorials/configure-nodemcu-iot-hub/index.mdx @@ -12,10 +12,12 @@ dates: tags: iot iot-hub NodeMCU Arduino-IDE hero: assets/scaleway_nodemcu.webp --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway's IoT Hub lets your connected devices share messages. In this tutorial, we use a [NodeMCU](https://www.nodemcu.com/index_en.html) embedded Microcontroller ([ESP8266](https://en.wikipedia.org/wiki/ESP8266)) with WiFi, and a DHT11 temperature sensor, to collect temperature and humidity information. We use the Arduino IDE to configure the microcontroller and transfer the data via WiFi to the IoT Hub. The data is then retrieved from the IoT Hub by [Node-RED](https://nodered.org/) to allow visualization in a dashboard. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-plex-s3/index.mdx b/tutorials/configure-plex-s3/index.mdx index 8102337bc7..03e302e5ad 100644 --- a/tutorials/configure-plex-s3/index.mdx +++ b/tutorials/configure-plex-s3/index.mdx @@ -14,13 +14,15 @@ dates: validation: 2025-01-30 posted: 2018-09-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Plex is a client/server media player system comprising two main components: - The **Plex Server** application, which is available for Windows, macOS, Linux, and even some NAS devices. - **Plex clients** that can be either a web-based interface, an application on smart TVs, streaming boxes, or other third-party applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-realtime-alerting-slack/index.mdx b/tutorials/configure-realtime-alerting-slack/index.mdx index c81e45ae7d..b217e8096b 100644 --- a/tutorials/configure-realtime-alerting-slack/index.mdx +++ b/tutorials/configure-realtime-alerting-slack/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-26 posted: 2020-11-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Nowadays, most companies use real-time messaging systems to have their teams communicate together from any location. Slack is one of the most popular such systems. @@ -28,7 +30,7 @@ There are three steps to achieve this: - Publish messages on the IoT Hub and see the messages on the Slack channel - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-slack-alerting/index.mdx b/tutorials/configure-slack-alerting/index.mdx index a99985eee3..8b2f6497ae 100644 --- a/tutorials/configure-slack-alerting/index.mdx +++ b/tutorials/configure-slack-alerting/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-02-18 posted: 2025-02-18 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create a Slack app, a Slack webhook, and your Slack integration using the `Scaleway Alerting` alert manager, and how to configure notification policies in Grafana to receive your Cockpit alert notifications in your Slack channel. As **we do not support Grafana managed alerts**, this documentation only shows you how to **send Cockpit alerts to your Slack channel**. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-smtp-relay-tem/index.mdx b/tutorials/configure-smtp-relay-tem/index.mdx index 05599b2fe6..ff98be2e9d 100644 --- a/tutorials/configure-smtp-relay-tem/index.mdx +++ b/tutorials/configure-smtp-relay-tem/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2023-08-08 --- +import Requirements from '@macros/iam/requirements.mdx' + Deploying an SMTP relay on your servers enhances your notification system, ensuring prompt alerts in case of issues, as servers typically report them via email. Moreover, it streamlines email-sending processes for software installed on the server, eliminating the need for complicated email configuration setups. @@ -20,7 +22,7 @@ Moreover, it streamlines email-sending processes for software installed on the s In this tutorial, you will learn how to set up [Postfix](https://en.wikipedia.org/wiki/Postfix_(software)) and configure Transactional Email's SMTP service to dispatch emails efficiently. For demonstration purposes, will walk through the configuration process on a MacOS system. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-tem-smtp-with-wordpress-plugin/index.mdx b/tutorials/configure-tem-smtp-with-wordpress-plugin/index.mdx index d98f9508c8..6a0759d461 100644 --- a/tutorials/configure-tem-smtp-with-wordpress-plugin/index.mdx +++ b/tutorials/configure-tem-smtp-with-wordpress-plugin/index.mdx @@ -13,8 +13,10 @@ dates: validation: 2025-05-22 posted: 2024-04-24 --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [Scaleway console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-virtual-machine-esxi/index.mdx b/tutorials/configure-virtual-machine-esxi/index.mdx index b782ee18ee..aaa108826e 100644 --- a/tutorials/configure-virtual-machine-esxi/index.mdx +++ b/tutorials/configure-virtual-machine-esxi/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-22 posted: 2020-01-27 --- +import Requirements from '@macros/iam/requirements.mdx' + Due to VMware's acquisition by Broadcom, the free edition of **VMware vSphere Hypervisor is no longer available** on the VMware website. For more details, check out [the EOL of free vSphere Hypervisor](https://knowledge.broadcom.com/external/article?legacyId=2107518). Please note that the following content is provided as-is, without any guarantee of functionality @@ -22,7 +24,7 @@ VMware ESXi is a hypervisor developed by VMware to deploy and manage virtual mac Management of the virtual machines can be done through an easy-to-use web interface. - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configure-vm-hyperv/index.mdx b/tutorials/configure-vm-hyperv/index.mdx index 62d3b5ff3b..7352d99417 100644 --- a/tutorials/configure-vm-hyperv/index.mdx +++ b/tutorials/configure-vm-hyperv/index.mdx @@ -12,11 +12,13 @@ dates: validation: 2025-05-26 posted: 2020-01-23 --- +import Requirements from '@macros/iam/requirements.mdx' + [Microsoft Hyper-V](https://learn.microsoft.com/en-us/windows-server/virtualization/hyper-v/hyper-v-on-windows-server) is a hypervisor that allows creating virtual machines on x86-64 systems. It is available since the release of Windows Server 2012. - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configuring-gitlab-scaleway-elements-database/index.mdx b/tutorials/configuring-gitlab-scaleway-elements-database/index.mdx index 4d57e4e68d..c6981bb747 100644 --- a/tutorials/configuring-gitlab-scaleway-elements-database/index.mdx +++ b/tutorials/configuring-gitlab-scaleway-elements-database/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-02-24 posted: 2019-11-08 --- +import Requirements from '@macros/iam/requirements.mdx' + GitLab serves as an open-core Git repository manager, offering a broad suite of features such as a wiki, issue tracking, and CI/CD pipelines. In the open-core model, the fundamental software functionalities are available under an open-source license, complemented by optional modules. @@ -22,7 +24,7 @@ For those seeking a dependable and high-performance hosting solution, Scaleway C We recommend you follow this tutorial using a [Cost-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/configuring-loadbalancer-wordpress/index.mdx b/tutorials/configuring-loadbalancer-wordpress/index.mdx index a25c20c455..3feb43c9b9 100644 --- a/tutorials/configuring-loadbalancer-wordpress/index.mdx +++ b/tutorials/configuring-loadbalancer-wordpress/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-27 posted: 2019-04-08 --- +import Requirements from '@macros/iam/requirements.mdx' + The capacity of a single server is limited. Once a website gains more and more attraction the Instance serving the site comes to a point where it can not handle any more users. The website starts to slow down or even become unavailable as the server goes down from the traffic. @@ -24,7 +26,7 @@ In this tutorial, you learn how to set up a Scaleway-managed Load Balancer with - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/connect-generative-apis-sql/index.mdx b/tutorials/connect-generative-apis-sql/index.mdx index 308f2b3659..3b033878be 100644 --- a/tutorials/connect-generative-apis-sql/index.mdx +++ b/tutorials/connect-generative-apis-sql/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-05-13 posted: 2025-05-13 --- +import Requirements from '@macros/iam/requirements.mdx' + [Model Context Protocol](https://modelcontextprotocol.io/introduction) (MCP) is an open, standardized communication protocol that enables Large Language Models to interact with external tools and services through a defined interface. @@ -22,7 +24,7 @@ This tutorial demonstrates how to build a data analysis agent that connects Scal - Convert natural language questions into SQL queries - Execute queries and present results in a human-friendly format - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing actions in the intended Organization diff --git a/tutorials/create-deploy-staging-site-cpanel/index.mdx b/tutorials/create-deploy-staging-site-cpanel/index.mdx index 834e4cd32c..392a168508 100644 --- a/tutorials/create-deploy-staging-site-cpanel/index.mdx +++ b/tutorials/create-deploy-staging-site-cpanel/index.mdx @@ -13,6 +13,8 @@ dates: categories: - webhosting --- +import Requirements from '@macros/iam/requirements.mdx' + A staging website mirrors your production website, containing identical data and files while remaining publicly inaccessible. Changes made on the staging website are isolated until being transferred to the production website after thorough checks from the design and development teams. Operating in the same environment as the production environment, it serves as an ideal testing ground. @@ -26,7 +28,7 @@ Creating a staging website for your WordPress website is a smart move, allowing * Implementing code changes to enhance functionality. * Evaluating updates for compatibility issues. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A [Web Hosting](/webhosting/) account diff --git a/tutorials/create-models-django/index.mdx b/tutorials/create-models-django/index.mdx index 3ae9e21c5c..72f3408e8f 100644 --- a/tutorials/create-models-django/index.mdx +++ b/tutorials/create-models-django/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2018-11-02 --- +import Requirements from '@macros/iam/requirements.mdx' + [Django](https://www.djangoproject.com/) is a web development framework for developing dynamic websites and applications. Django allows the use of less code and eases the creation of complex websites. It provides a very good structure and easy methods that help to do the heavy lifting when writing web applications. @@ -22,7 +24,7 @@ To follow this tutorial, we assume that you completed the [first tutorial on Dja We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/create-openwrt-image-for-scaleway/index.mdx b/tutorials/create-openwrt-image-for-scaleway/index.mdx index 3ebb5cad1a..1ffd9c66e9 100644 --- a/tutorials/create-openwrt-image-for-scaleway/index.mdx +++ b/tutorials/create-openwrt-image-for-scaleway/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-09 posted: 2022-10-24 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial shows how to build a custom image for Scaleway from scratch using the new export/import feature. @@ -33,7 +35,7 @@ The following steps are required to create the image: - Convert to Snapshot through import - Test the image and troubleshoot via the Console - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/create-serverless-scraping/index.mdx b/tutorials/create-serverless-scraping/index.mdx index 81ba291477..bfab828f3a 100644 --- a/tutorials/create-serverless-scraping/index.mdx +++ b/tutorials/create-serverless-scraping/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-05-19 posted: 2023-12-08 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, we show how to set up a simple application that reads [Hacker News](https://news.ycombinator.com) and processes the articles it finds there asynchronously. To do so, we use Scaleway serverless products and deploy two functions: - A producer function, activated by a recurrent cron trigger, that scrapes HackerNews for articles published in the last 15 minutes and pushes the title and URL of the articles to a queue created with Scaleway Queues. @@ -27,7 +29,7 @@ This project exemplifies a decoupled architecture, where producer and consumer p You can find all of the code on [GitHub](https://github.com/scaleway/serverless-scraping-tutorial), so feel free to dive right in, or else follow along with the step-by-step explanation below to create the architecture yourself. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Set up [authentication for the Terraform/OpenTofu provider](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs#authentication) diff --git a/tutorials/create-valheim-server/index.mdx b/tutorials/create-valheim-server/index.mdx index abe32dbcf0..ac2fc78661 100644 --- a/tutorials/create-valheim-server/index.mdx +++ b/tutorials/create-valheim-server/index.mdx @@ -12,6 +12,8 @@ dates: categories: - instances --- +import Requirements from '@macros/iam/requirements.mdx' + Valheim is a survival and sandbox video game that was released in early access on February 2nd, 2021 for Windows and Linux on Steam. Within only one month after its release the game sold more than 5 million copies and is one of the most played games on Steam. @@ -21,7 +23,7 @@ Players of the game are Vikings in an afterlife where they have to complete miss At Scaleway, we offer a large range of Instances that will suit the gaming needs of your Valheim server. In this tutorial, you will learn how to create your own Valheim server with Scaleway Instances. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/create-wordpress-instances-cli/index.mdx b/tutorials/create-wordpress-instances-cli/index.mdx index b1103fb239..9f434f3c78 100644 --- a/tutorials/create-wordpress-instances-cli/index.mdx +++ b/tutorials/create-wordpress-instances-cli/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2021-10-11 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to create WordPress Instances with the Scaleway CLI. Refer to our [tutorial on creating WordPress Instances from the Scaleway console](/tutorials/wordpress-instantapp/) to create an Instance from the [Scaleway console](https://console.scaleway.com/). By default, the WordPress image used in this tutorial [supports routed IPs](/instances/api-cli/using-routed-ips/). @@ -21,7 +23,7 @@ Working with the WordPress InstantApp significantly saves you time and effort as The new WordPress image is updated regularly to be as close as possible to the latest release. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/custom-email-domain-icloud/index.mdx b/tutorials/custom-email-domain-icloud/index.mdx index 4a247314ac..35c5a3ec63 100644 --- a/tutorials/custom-email-domain-icloud/index.mdx +++ b/tutorials/custom-email-domain-icloud/index.mdx @@ -11,12 +11,14 @@ categories: dates: posted: 2025-04-02 --- +import Requirements from '@macros/iam/requirements.mdx' + iCloud is Apple's service that allows you to securely store and manage your data across the entire Apple ecosystem. While it is most commonly used for the storage of photos or the backup of devices in the cloud, an iCloud+ feature correctly named **Custom Email Domain** allows you to set up an email address with your own domain. - + - An iCloud account upgraded with [iCloud+ premium features](https://support.apple.com/en-us/108047) - [Configured a domain name](/domains-and-dns/quickstart/) diff --git a/tutorials/dagster-serverless-jobs/index.mdx b/tutorials/dagster-serverless-jobs/index.mdx index b14625ef90..211ff77d36 100644 --- a/tutorials/dagster-serverless-jobs/index.mdx +++ b/tutorials/dagster-serverless-jobs/index.mdx @@ -15,6 +15,8 @@ dates: validation: 2025-02-11 posted: 2024-01-23 --- +import Requirements from '@macros/iam/requirements.mdx' + [Dagster](https://docs.dagster.io/getting-started) is an orchestrator designed for developing and maintaining data assets, such as tables, data sets, machine learning models, and reports. @@ -24,7 +26,7 @@ In this tutorial, we will create a [Serverless Job](/serverless-jobs/quickstart/ First, we will initialize the Dagster project locally and add the scraper's source code to it. Then, we will set up the environment, build the image and push it to the Scaleway registry. Finally, we will execute Dagster locally to scrape the Hacker News top stories through the Dagster UI. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-angular-application/index.mdx b/tutorials/deploy-angular-application/index.mdx index 61d70f0616..a49118fa85 100644 --- a/tutorials/deploy-angular-application/index.mdx +++ b/tutorials/deploy-angular-application/index.mdx @@ -11,12 +11,14 @@ dates: validation: 2025-05-26 posted: 2022-04-26 --- +import Requirements from '@macros/iam/requirements.mdx' + Angular 19 is the latest development platform that scales from single-developer projects to enterprise-level applications. The platform provides enhanced performance, better server-side rendering, and a robust component-based framework. ### Prerequisites - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-automate-mkdocs-site/index.mdx b/tutorials/deploy-automate-mkdocs-site/index.mdx index f5341bb4a3..0cbb646ecd 100644 --- a/tutorials/deploy-automate-mkdocs-site/index.mdx +++ b/tutorials/deploy-automate-mkdocs-site/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-03-13 posted: 2025-03-13 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial is the second in a series on building and deploying websites using the Scaleway ecosystem. In the [first tutorial](/tutorials/using-bucket-website-with-mkdocs/), we covered how to configure your website. Now, we will walk you through the process of building and deploying it using GitHub Actions CI/CD, the [Object Storage bucket website](/object-storage/concepts/#bucket-website) feature, and MkDocs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-awstats/index.mdx b/tutorials/deploy-awstats/index.mdx index ed9301ff86..dfa39e74d3 100644 --- a/tutorials/deploy-awstats/index.mdx +++ b/tutorials/deploy-awstats/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-02 posted: 2018-12-03 --- +import Requirements from '@macros/iam/requirements.mdx' + AwStats serves as a valuable utility capable of providing a comprehensive overview of your website's activity while aiding in site analysis. This open-source web analytics reporting tool generates advanced statistics for web, streaming, FTP, and mail servers in a visually informative manner. @@ -19,7 +21,7 @@ This software stands as a robust, enterprise-level server and log monitoring sol AwStats leverages log file analysis to parse data from a wide range of web servers, including Apache, IIS, and numerous others. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-chatwoot-self-care/index.mdx b/tutorials/deploy-chatwoot-self-care/index.mdx index 38af194f06..08228bac82 100644 --- a/tutorials/deploy-chatwoot-self-care/index.mdx +++ b/tutorials/deploy-chatwoot-self-care/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2023-05-16 --- +import Requirements from '@macros/iam/requirements.mdx' + Chatwoot is an open-source customer communication platform that enables businesses to engage with their customers through various communication channels such as live chat, email, and social media. It provides a centralized inbox for managing customer conversations, allowing businesses to respond to customer queries and support requests in a unified and efficient manner. @@ -21,7 +23,7 @@ As an open-source platform, Chatwoot allows businesses to customize and extend i Chatwoot is designed to enhance customer satisfaction and improve customer support efficiency by providing businesses with the tools they need to manage and track customer conversations across multiple channels in a single platform. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-clickhouse-database/index.mdx b/tutorials/deploy-clickhouse-database/index.mdx index d3ef07daff..b392331e6b 100644 --- a/tutorials/deploy-clickhouse-database/index.mdx +++ b/tutorials/deploy-clickhouse-database/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-01-02 posted: 2022-12-01 --- +import Requirements from '@macros/iam/requirements.mdx' + ClickHouse® is an open-source column-oriented database management system that allows you to generate analytical data reports in real-time. It uses a user-friendly SQL query dialect, provides built-in analytics capabilities, and its performance exceeds all other column-oriented database management systems. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-hasura-engine-database-postgresql/index.mdx b/tutorials/deploy-hasura-engine-database-postgresql/index.mdx index b409b2a612..33eaea7e1e 100644 --- a/tutorials/deploy-hasura-engine-database-postgresql/index.mdx +++ b/tutorials/deploy-hasura-engine-database-postgresql/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-02 posted: 2020-07-08 --- +import Requirements from '@macros/iam/requirements.mdx' + The [Hasura GraphQL Engine](https://hasura.io) is a [GraphQL](https://graphql.org/) server and provides developers with real-time GraphQL APIs for Postgres applications. The application allows you to configure webhook triggers on database events and helps you build GraphQL apps backed by Postgres or incrementally move to GraphQL for existing applications using Postgres. @@ -22,7 +24,7 @@ In this tutorial, you will learn how to get started with Hasura GraphQL Engine u Make sure you save your secret and access keys, as you will need them in the following step. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-instances-packer-terraform/index.mdx b/tutorials/deploy-instances-packer-terraform/index.mdx index 70623c2c28..8523fe19e4 100644 --- a/tutorials/deploy-instances-packer-terraform/index.mdx +++ b/tutorials/deploy-instances-packer-terraform/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-04-08 posted: 2018-08-01 --- +import Requirements from '@macros/iam/requirements.mdx' + **Packer** is a tool for creating identical machine images for multiple platforms from a single source configuration file. It can build images for multiple cloud hosting platforms, including Scaleway. @@ -21,7 +23,7 @@ dates: Both applications are available for Linux, macOS, Windows, FreeBSD, and NetBSD. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-istio-kapsule-proxy-protocol/index.mdx b/tutorials/deploy-istio-kapsule-proxy-protocol/index.mdx index 3e3831df8c..2da3310bfd 100644 --- a/tutorials/deploy-istio-kapsule-proxy-protocol/index.mdx +++ b/tutorials/deploy-istio-kapsule-proxy-protocol/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-03-13 posted: 2025-02-18 --- +import Requirements from '@macros/iam/requirements.mdx' + Istio is an open source service mesh that lets you run distributed, microservices-based apps anywhere. It helps you manage and connect the different microservices in your Scaleway Kubernetes cluster, making it easier to build and maintain complex applications. This tutorial describes the steps required to deploy Istio on a Scaleway Kubernetes Kapsule cluster, and configure it to support [Proxy Protocol v2](/load-balancer/concepts/#proxy-protocol). This enables connection information from a client (e.g. their IP address) to be passed through the cluster's Load Balancer onto the target pod or service, via the Istio service mesh. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-k3s-cluster-with-cilium/index.mdx b/tutorials/deploy-k3s-cluster-with-cilium/index.mdx index 8a341d23aa..470c0584f3 100644 --- a/tutorials/deploy-k3s-cluster-with-cilium/index.mdx +++ b/tutorials/deploy-k3s-cluster-with-cilium/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-05-12 posted: 2023-10-23 --- +import Requirements from '@macros/iam/requirements.mdx' + This step-by-step guide is designed to help you set up a highly efficient Kubernetes environment while minimizing costs and focusing on essential functionality. It caters to those seeking to enhance their understanding of Kubernetes and Cilium, helping them address the specific needs of budget-conscious users and IPv6 implementers. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/tutorials/deploy-laravel-on-serverless-containers/index.mdx b/tutorials/deploy-laravel-on-serverless-containers/index.mdx index b5b0014885..5f21133534 100644 --- a/tutorials/deploy-laravel-on-serverless-containers/index.mdx +++ b/tutorials/deploy-laravel-on-serverless-containers/index.mdx @@ -14,10 +14,12 @@ dates: validation: 2025-05-19 posted: 2023-06-01 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial provides a step-by-step guide for deploying a containerized Laravel application on the Scaleway cloud platform. It covers the entire process, from setting up the required infrastructure to building and deploying the application using Docker and Scaleway services. The tutorial aims to help developers easily deploy their Laravel applications on Scaleway by providing clear instructions and best practices. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-librechat-with-generative-apis/index.mdx b/tutorials/deploy-librechat-with-generative-apis/index.mdx index 75e27782e9..c67d14ac7c 100644 --- a/tutorials/deploy-librechat-with-generative-apis/index.mdx +++ b/tutorials/deploy-librechat-with-generative-apis/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-03-13 posted: 2025-03-13 --- +import Requirements from '@macros/iam/requirements.mdx' + LibreChat is a free, open-source AI chat platform that unifies interactions with various AI models through a single, customizable interface. It supports multiple AI providers, including Scaleway's Generative APIs, allowing users to switch seamlessly between different models. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-mdbooks-serverless-containers/index.mdx b/tutorials/deploy-mdbooks-serverless-containers/index.mdx index 25321c1cf7..b14e0381eb 100644 --- a/tutorials/deploy-mdbooks-serverless-containers/index.mdx +++ b/tutorials/deploy-mdbooks-serverless-containers/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-19 posted: 2024-10-30 --- +import Requirements from '@macros/iam/requirements.mdx' + [mdBook](https://rust-lang.github.io/mdBook/) lets you publish modern online books, for product, API documentation, tutorials, course material or anything that requires a clean, easily navigable, and customizable presentation. This tutorial uses `mdbook` to publish simple documentation but the main goal of this tutorial is to show how simple it is to pick a project, package it inside an image, and deploy it on Serverless Containers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-meilisearch-instance/index.mdx b/tutorials/deploy-meilisearch-instance/index.mdx index 5f5e580912..c18d955e0e 100644 --- a/tutorials/deploy-meilisearch-instance/index.mdx +++ b/tutorials/deploy-meilisearch-instance/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-02-11 posted: 2024-07-25 --- +import Requirements from '@macros/iam/requirements.mdx' + Meilisearch is an open-source search engine that provides instant and relevant search results from large collections of data. [Meilisearch](https://www.meilisearch.com/) is particularly useful for applications that require fast and efficient search capabilities, such as e-commerce sites, documentation search, and any platform where users need to quickly find relevant information from a large dataset. This tutorial shows you how to deploy a Meilisearch search engine on a [Scaleway Instance](/instances/). - + - A Scaleway account logged into the [console](https://console.scaleway.com/) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) (specifically **InstancesFullAccess**) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-nextcloud-s3/index.mdx b/tutorials/deploy-nextcloud-s3/index.mdx index b751234b53..0c781df542 100644 --- a/tutorials/deploy-nextcloud-s3/index.mdx +++ b/tutorials/deploy-nextcloud-s3/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-07 posted: 2018-11-16 --- +import Requirements from '@macros/iam/requirements.mdx' + NextCloud is an open-source, self-hosted file share and communication platform. Combining NextCloud with Scaleway Object Storage gives you infinite storage space for your personal cloud. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-openproject-database-postgresql/index.mdx b/tutorials/deploy-openproject-database-postgresql/index.mdx index e8c23cda65..2595b4d1f2 100644 --- a/tutorials/deploy-openproject-database-postgresql/index.mdx +++ b/tutorials/deploy-openproject-database-postgresql/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-02-18 posted: 2020-07-23 --- +import Requirements from '@macros/iam/requirements.mdx' + OpenProject is an open-source project management software. Available in more than 30 languages, it provides tools and features to assist teams with communication, collaboration, and navigating the lifecycle of a project. @@ -21,7 +23,7 @@ The software helps users to organize projects from their initial stages of [conc In this tutorial, you will learn how to install and configure OpenProject on an Instance running Ubuntu Focal Fossa 20.04 while integrating a PostgreSQL [Database](https://www.scaleway.com/en/database/) into your stack. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-openwebui-with-generative-apis/index.mdx b/tutorials/deploy-openwebui-with-generative-apis/index.mdx index c648bf73ff..e0215fb73f 100644 --- a/tutorials/deploy-openwebui-with-generative-apis/index.mdx +++ b/tutorials/deploy-openwebui-with-generative-apis/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-02-17 posted: 2025-02-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Integrating Scaleway's Generative APIs with Open WebUI allows you to leverage powerful AI models in a user-friendly, self-hosted interface. Open WebUI is an open-source frontend that simplifies interactions with AI models, providing an intuitive alternative to proprietary AI interfaces. @@ -26,7 +28,7 @@ This tutorial will guide you through: By the end, you will have a fully functional AI-powered setup. - + ### Prerequisites diff --git a/tutorials/deploy-penpot-with-docker-instantapp/index.mdx b/tutorials/deploy-penpot-with-docker-instantapp/index.mdx index 0a2d26782e..e03a83c64b 100644 --- a/tutorials/deploy-penpot-with-docker-instantapp/index.mdx +++ b/tutorials/deploy-penpot-with-docker-instantapp/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2022-09-28 hero: assets/scaleway-penpot.webp --- +import Requirements from '@macros/iam/requirements.mdx' + Penpot is an open-source design and prototyping platform designed for cross-domain teams. It is completely web-based and works with open web standards (SVG). Penpot can run in almost any modern browser, regardless of the underlying operating system. In this tutorial, you learn how to deploy your own Penpot Instance using the Docker [InstantApp](/tutorials/docker-instantapp/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-phpmyadmin-with-docker/index.mdx b/tutorials/deploy-phpmyadmin-with-docker/index.mdx index d2de012e74..9e01023084 100644 --- a/tutorials/deploy-phpmyadmin-with-docker/index.mdx +++ b/tutorials/deploy-phpmyadmin-with-docker/index.mdx @@ -13,13 +13,15 @@ dates: validation: 2025-03-06 posted: 2018-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Managing a database can be a complex and laborious part when running a web application. Software like phpMyAdmin exist to make the process much lighter. It is a popular administration tool that allows you to access and manage your databases much more easily. In this tutorial, you learn how to deploy the tool on an [Instance](https://www.scaleway.com/en/virtual-instances/) using the [Docker](https://www.docker.com/) InstantApp. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-remote-desktop-ubuntu-2204/index.mdx b/tutorials/deploy-remote-desktop-ubuntu-2204/index.mdx index 592edf4b67..36b6e2b888 100644 --- a/tutorials/deploy-remote-desktop-ubuntu-2204/index.mdx +++ b/tutorials/deploy-remote-desktop-ubuntu-2204/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2022-05-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Instances can be used with third-party software to enable remote desktop functionality. @@ -29,7 +31,7 @@ This tutorial guides you through deploying a remote desktop on an Instance runni - [xRDP](http://xrdp.org/): An open-source alternative to Microsoft RDP (Remote Desktop Protocol). - [Xfce](https://xfce.org/): A lightweight and stable desktop environment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-saas-application/index.mdx b/tutorials/deploy-saas-application/index.mdx index 7f5ceaa026..9d14d77dc4 100644 --- a/tutorials/deploy-saas-application/index.mdx +++ b/tutorials/deploy-saas-application/index.mdx @@ -15,6 +15,8 @@ dates: validation: 2025-03-27 posted: 2021-03-09 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to deploy a Software-as-a-Service (SaaS) application, based on a SaaS application developed using Django Template. You use the following Scaleway products: @@ -25,7 +27,7 @@ In this tutorial, you will learn how to deploy a Software-as-a-Service (SaaS) ap You will learn how to store environment variables with Kubernetes secrets and use ImagePullSecrets to pull your private images. We also give you some tips for going further with your deployed SaaS application, including how to expose it with a Scaleway Load Balancer. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-static-website-with-hugo-and-github-runners-to-object-storage/index.mdx b/tutorials/deploy-static-website-with-hugo-and-github-runners-to-object-storage/index.mdx index 188db59bbe..81f83505ef 100644 --- a/tutorials/deploy-static-website-with-hugo-and-github-runners-to-object-storage/index.mdx +++ b/tutorials/deploy-static-website-with-hugo-and-github-runners-to-object-storage/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-06-25 posted: 2022-12-07 --- +import Requirements from '@macros/iam/requirements.mdx' + Hugo, coded in Go, serves as a static HTML and CSS website generator. Its purpose is to transform a directory containing content and templates into a complete HTML website. The application relies on Markdown files with front matter to handle metadata, ensuring a lightweight and user-friendly experience. This tutorial will guide you through the process of installing Hugo on your local computer. This enables you to develop your website locally. Later, you can seamlessly push your content to a GitHub repository where a GitHub runner will take charge, generating the HTML version and automatically uploading it to a Scaleway Object Storage bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-ubuntu-20-04-instance-scaleway-elements/index.mdx b/tutorials/deploy-ubuntu-20-04-instance-scaleway-elements/index.mdx index c1ed20bd88..b1e73074e0 100644 --- a/tutorials/deploy-ubuntu-20-04-instance-scaleway-elements/index.mdx +++ b/tutorials/deploy-ubuntu-20-04-instance-scaleway-elements/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-05 posted: 2021-12-02 --- +import Requirements from '@macros/iam/requirements.mdx' + Ubuntu 20.04 LTS (Focal Fossa) will reach its **End of Standard Support in May 2025**. For security and maintenance reasons, we strongly recommend using a more recent version of Ubuntu for your deployment. @@ -25,7 +27,7 @@ Ubuntu is developed and maintained by the company [Canonical](https://canonical. In this tutorial, you will learn how to deploy an Instance with Ubuntu 20.04 LTS (Focal Fossa) from the Scaleway console and configure it for hosting your apps and websites. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-ubuntu-22-04-instance/index.mdx b/tutorials/deploy-ubuntu-22-04-instance/index.mdx index 0e7b4bff48..b0073e8f30 100644 --- a/tutorials/deploy-ubuntu-22-04-instance/index.mdx +++ b/tutorials/deploy-ubuntu-22-04-instance/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-06 posted: 2022-08-11 --- +import Requirements from '@macros/iam/requirements.mdx' + Ubuntu is one of the most popular Linux distributions. First released in 2004, Ubuntu, whose name is based on an ancient African word meaning _humanity to others_, quickly became the favorite Linux distribution of users around the world, mostly because it is easy to install and use. @@ -19,7 +21,7 @@ Ubuntu is developed and maintained by the company [Canonical](https://canonical. In this tutorial, you learn how to deploy an Instance with Ubuntu 22.04 LTS (Jammy Jellyfish) from the Scaleway console and configure it for hosting your apps and websites. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-umami-on-serverless-containers/index.mdx b/tutorials/deploy-umami-on-serverless-containers/index.mdx index ed4244b441..b40354c9ce 100644 --- a/tutorials/deploy-umami-on-serverless-containers/index.mdx +++ b/tutorials/deploy-umami-on-serverless-containers/index.mdx @@ -15,10 +15,12 @@ dates: validation: 2025-03-27 posted: 2021-04-21 --- +import Requirements from '@macros/iam/requirements.mdx' + Umami is a simple, easy-to-use, self-hosted web analytics solution. It provides an easy-to-use, open-source, and privacy-focused alternative to paid solutions such as Google Analytics. The tool collects only the metrics relevant to you and displays everything on a single page. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-wordpress-from-application-library/index.mdx b/tutorials/deploy-wordpress-from-application-library/index.mdx index b25b5eaa30..fd65a6bcf5 100644 --- a/tutorials/deploy-wordpress-from-application-library/index.mdx +++ b/tutorials/deploy-wordpress-from-application-library/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2022-04-07 --- +import Requirements from '@macros/iam/requirements.mdx' + WordPress is a well-known CMS (**C**ontent **M**anagement **S**ystem) allowing you to create evolving websites. @@ -19,7 +21,7 @@ This tutorial teaches you how to install WordPress on a Scaleway Kubernetes Kaps You can perform most of these steps directly from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploy-wordpress-managed-database-mysql8/index.mdx b/tutorials/deploy-wordpress-managed-database-mysql8/index.mdx index 3a8ea5e326..ff634a2920 100644 --- a/tutorials/deploy-wordpress-managed-database-mysql8/index.mdx +++ b/tutorials/deploy-wordpress-managed-database-mysql8/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-25 posted: 2020-06-22 --- +import Requirements from '@macros/iam/requirements.mdx' + Learn how to set up your own WordPress blog on a Scaleway Instance, supported by a robust MySQL 8 database. Scaleway Managed Database for MySQL 8 offers up to 48 cores and 256 GB of RAM, ensuring optimal performance and reliability for your project. @@ -20,7 +22,7 @@ WordPress, a PHP-based content management system, relies on MySQL to store its d With its customizable themes and extensive plugin ecosystem, WordPress provides unparalleled flexibility for developers and administrators to tailor the look and functionality of their blogs. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploying-a-documentation-website-with-docusaurus-on-scaleway/index.mdx b/tutorials/deploying-a-documentation-website-with-docusaurus-on-scaleway/index.mdx index 87e4c0097d..cc0c6e9204 100644 --- a/tutorials/deploying-a-documentation-website-with-docusaurus-on-scaleway/index.mdx +++ b/tutorials/deploying-a-documentation-website-with-docusaurus-on-scaleway/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-02-11 posted: 2023-01-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Docusaurus is an open-source documentation framework. It allows you to build, deploy, and maintain documentation websites. It comes with features such as blogs, internationalization, search, and versioning. It builds a single-page application with fast client-side navigation, leveraging the full power of React to make your site interactive. The tool is a static-site generator and provides out-of-the-box documentation features - but can be used to create any kind of static website (personal website, product, blog, marketing landing pages, etc.). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploying-hubble-add-on-scaleway-kubernetes-clusters/index.mdx b/tutorials/deploying-hubble-add-on-scaleway-kubernetes-clusters/index.mdx index 5504d6e6d6..256ccb21e1 100644 --- a/tutorials/deploying-hubble-add-on-scaleway-kubernetes-clusters/index.mdx +++ b/tutorials/deploying-hubble-add-on-scaleway-kubernetes-clusters/index.mdx @@ -12,13 +12,15 @@ dates: validation: 2025-03-05 posted: 2025-03-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Hubble is a network observability and security monitoring tool for Cilium. This guide covers two methods to deploy Hubble on a Scaleway Kubernetes cluster: - [Using the Scaleway Console (Easy Deploy)](#deploying-via-scaleway-console-easy-deploy) - [Using the Scaleway CLI with Helm](#deploying-via-cli-with-helm) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/deploying-qdrant-vectordb-kubernetes/index.mdx b/tutorials/deploying-qdrant-vectordb-kubernetes/index.mdx index 8071fee5a7..750b8d1891 100644 --- a/tutorials/deploying-qdrant-vectordb-kubernetes/index.mdx +++ b/tutorials/deploying-qdrant-vectordb-kubernetes/index.mdx @@ -12,6 +12,8 @@ dates: categories: - kubernetes --- +import Requirements from '@macros/iam/requirements.mdx' + Qdrant Hybrid Cloud is a fully managed vector database that seamlessly integrates with existing Scaleway Kubernetes Kapsule environments. It enhances Large Language Models (LLMs) through Retrieval Augmented Generation (RAG), enabling precise and context-rich responses in real-time. @@ -26,7 +28,7 @@ Key benefits of running Qdrant Hybrid Cloud on Scaleway include: - European roots and focus: Scaleway's presence in Europe aligns well with Qdrant's European roots, offering local expertise and infrastructure that adhere to European regulatory standards. - Sustainability commitment: Scaleway focuses on sustainability with eco-conscious data centers and an extended hardware lifecycle, reducing the environmental impact. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A Qdrant Hybrid Cloud account logged into the [management console](https://cloud.qdrant.io/) diff --git a/tutorials/dhclient-dedibox/index.mdx b/tutorials/dhclient-dedibox/index.mdx index f948e85502..15754e8a9b 100644 --- a/tutorials/dhclient-dedibox/index.mdx +++ b/tutorials/dhclient-dedibox/index.mdx @@ -12,6 +12,8 @@ dates: categories: - dedibox --- +import Requirements from '@macros/iam/requirements.mdx' + It is now recommended to use the systemd-networkd DHCP client as the one provided by the internet Systems Consortium, [dhclient](https://github.com/isc-projects/dhcp), has reached its End of Life (EOL) on 5th October 2022. @@ -19,7 +21,7 @@ categories: To install DHCPCD on a Dedibox dedicated server, refer to the [dedicated documentation](/tutorials/dhcpcd-dedibox/). - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server](/dedibox/how-to/order-a-server/) diff --git a/tutorials/dhcpcd-dedibox/index.mdx b/tutorials/dhcpcd-dedibox/index.mdx index 1bd5ae09e0..7fa66cee91 100644 --- a/tutorials/dhcpcd-dedibox/index.mdx +++ b/tutorials/dhcpcd-dedibox/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-19 posted: 2021-03-12 --- +import Requirements from '@macros/iam/requirements.mdx' + [dhcpcd](https://roy.marples.name/projects/dhcpcd/) is an open-source DHCP client, supporting both IPv4, and IPv6. The feature-rich software can be used to configure and automate network-related parameters of your computer using the [DHCP protocol](http://en.wikipedia.org/wiki/Dynamic_Host_Configuration_Protocol). @@ -21,7 +23,7 @@ Roy Marples' dhcpcd (DHCP _client_ daemon) is not the same as the discontinued i In this tutorial, you will learn how to configure your IPv6 subnet with DHCPCD on a Scaleway Dedibox dedicated server. - + - A Dedibox account logged into the [console](https://console.online.net) - A [Dedibox dedicated server] (https://www.scaleway.com/en/dedibox) diff --git a/tutorials/discourse-forum/index.mdx b/tutorials/discourse-forum/index.mdx index 5afb4cd953..b093d88882 100644 --- a/tutorials/discourse-forum/index.mdx +++ b/tutorials/discourse-forum/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-19 posted: 2020-04-21 --- +import Requirements from '@macros/iam/requirements.mdx' + Discourse is an open-source internet forum software application, distinguished by its incorporation of features popularized by major social networks. @@ -22,7 +24,7 @@ Developed with [Ember.js](https://emberjs.com/) and [Ruby on Rails](https://ruby Released under the GNU General Public License version 2, its source code is freely available on GitHub. For those looking to set up Discourse, using the official [Docker image](https://github.com/discourse/discourse_docker) streamlines the process. This container encapsulates all necessary components, simplifying deployment, administration, and software updates. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/django-ubuntu-focal-fossa/index.mdx b/tutorials/django-ubuntu-focal-fossa/index.mdx index 3c8866b9cf..27bd242a4d 100644 --- a/tutorials/django-ubuntu-focal-fossa/index.mdx +++ b/tutorials/django-ubuntu-focal-fossa/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2018-10-29 --- +import Requirements from '@macros/iam/requirements.mdx' + Django is a web development framework that allows you to develop dynamic websites and applications. Django allows the use of less code and eases the creation of complex websites. It provides a very good structure and easy methods that help do the heavy lifting when writing web applications. @@ -29,7 +31,7 @@ In this tutorial, we install Django using `pip` in a virtual environment, as it We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/docker-instantapp/index.mdx b/tutorials/docker-instantapp/index.mdx index 748d8e1c97..0e596e3970 100644 --- a/tutorials/docker-instantapp/index.mdx +++ b/tutorials/docker-instantapp/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-07-02 posted: 2019-05-13 --- +import Requirements from '@macros/iam/requirements.mdx' + Docker is an open-source containerization platform. Docker allows developers to package their applications into containers, using OS-level virtualization. This page shows you how to create an Instance with Docker preinstalled using the Docker [InstantApp](/instances/concepts/#instantapp) based on Ubuntu 22.04, and then how to start using Docker for your containerization projects. By default, this image supports [routed IPs](/instances/api-cli/using-routed-ips/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/easydeploy-argocd/index.mdx b/tutorials/easydeploy-argocd/index.mdx index 3a9eefb6ff..32a267c5e9 100644 --- a/tutorials/easydeploy-argocd/index.mdx +++ b/tutorials/easydeploy-argocd/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2024-06-13 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes. It synchronizes application definitions from a Git repository, ensuring that the desired state of applications is maintained across clusters. @@ -20,7 +22,7 @@ Designed for high scalability and automation, Argo CD supports multi-cluster dep This makes it ideal for managing complex Kubernetes environments with precision and reliability. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/easydeploy-gitlab-runner/index.mdx b/tutorials/easydeploy-gitlab-runner/index.mdx index 909f918045..14e4930f3b 100644 --- a/tutorials/easydeploy-gitlab-runner/index.mdx +++ b/tutorials/easydeploy-gitlab-runner/index.mdx @@ -11,13 +11,15 @@ dates: validation: 2025-01-06 posted: 2024-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + GitLab Runner is a powerful tool that executes CI/CD jobs in GitLab. When hosted on Kubernetes, it leverages the scalability and resilience of container orchestration to efficiently manage and run your pipelines. By deploying GitLab Runner on a Kubernetes cluster, you can dynamically scale the number of runners based on demand, ensure high availability, and seamlessly integrate with your existing Kubernetes infrastructure. This setup enables you to optimize resource utilization, reduce overhead, and enhance the performance of your continuous integration and deployment processes. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/easydeploy-gitlab-server/index.mdx b/tutorials/easydeploy-gitlab-server/index.mdx index 889b73ce04..f5f532a640 100644 --- a/tutorials/easydeploy-gitlab-server/index.mdx +++ b/tutorials/easydeploy-gitlab-server/index.mdx @@ -13,11 +13,13 @@ dates: posted: 2024-06-20 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial provides a guide to deploy a GitLab server on Scaleway Kubernetes clusters using the Easy Deploy feature. It outlines the prerequisites, step-by-step deployment instructions, and post-deployment configurations necessary for optimal continuous delivery and GitOps practices. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/easydeploy-grafana/index.mdx b/tutorials/easydeploy-grafana/index.mdx index 9e0d0f2bb1..a1f5988c95 100644 --- a/tutorials/easydeploy-grafana/index.mdx +++ b/tutorials/easydeploy-grafana/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2024-06-13 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Grafana is a powerful open-source platform for monitoring and observability, allowing users to visualize and analyze metrics from various data sources. It provides interactive dashboards, alerts, and custom reports, making it invaluable for tracking system performance, diagnosing issues, and gaining insights into complex environments. Grafana's flexibility and ease of use make it a popular choice for managing applications and infrastructure. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/easydeploy-vault/index.mdx b/tutorials/easydeploy-vault/index.mdx index 8359e0be5c..45c38830c2 100644 --- a/tutorials/easydeploy-vault/index.mdx +++ b/tutorials/easydeploy-vault/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2024-06-13 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + HashiCorp Vault is an identity-based secrets and encryption management system. It provides encryption services that are gated by authentication and authorization methods to ensure secure, auditable and restricted access to secrets. Vault is used to secure, store and protect secrets and other sensitive data using a UI, CLI, or HTTP API. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/enabling-encryption-in-kapsule-with-cilium/index.mdx b/tutorials/enabling-encryption-in-kapsule-with-cilium/index.mdx index bf5799281f..befaf6338c 100644 --- a/tutorials/enabling-encryption-in-kapsule-with-cilium/index.mdx +++ b/tutorials/enabling-encryption-in-kapsule-with-cilium/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2024-12-31 posted: 2024-12-31 --- +import Requirements from '@macros/iam/requirements.mdx' + This guide explains how to enable WireGuard encryption in Scaleway’s Kapsule Managed Kubernetes service. By default, Cilium is selected as the CNI when creating a cluster. We will configure encryption via a `CiliumNodeConfig` resource and then verify that traffic is indeed encrypted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A functional [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule) cluster running **version 1.31**.- diff --git a/tutorials/encode-videos-using-serverless-jobs/index.mdx b/tutorials/encode-videos-using-serverless-jobs/index.mdx index 738fe1c0be..9209852849 100644 --- a/tutorials/encode-videos-using-serverless-jobs/index.mdx +++ b/tutorials/encode-videos-using-serverless-jobs/index.mdx @@ -14,10 +14,12 @@ dates: validation: 2025-06-09 posted: 2024-05-15 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial demonstrates the process of encoding videos retrieved from Object Storage using Serverless Jobs. Media encoding is a resource-intensive task of prolonged duration, making it a highly suitable candidate for Serverless Jobs. The job takes a video file as its input, encodes it using a Docker image based on [FFMPEG](https://ffmpeg.org/), then uploads the encoded video back to the Object Storage bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/encrypt-s3-data-rclone/index.mdx b/tutorials/encrypt-s3-data-rclone/index.mdx index 2930f2282e..afca86632b 100644 --- a/tutorials/encrypt-s3-data-rclone/index.mdx +++ b/tutorials/encrypt-s3-data-rclone/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2020-06-10 --- +import Requirements from '@macros/iam/requirements.mdx' + Rclone is a versatile open-source command-line tool designed to streamline file management across cloud storage platforms. Built using the Go programming language, it provides broad protocol support, enabling seamless integration with diverse storage systems. @@ -21,7 +23,7 @@ Compatible with Windows, macOS X, and various Linux distributions, Rclone addres In this tutorial, we will explore the capabilities of the **Rclone crypt** module, which empowers users to encrypt their data seamlessly before transmitting it to Scaleway Object Storage via the Amazon S3 protocol. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/encrypt-volumes/index.mdx b/tutorials/encrypt-volumes/index.mdx index a3e873939c..ae2edb88a1 100644 --- a/tutorials/encrypt-volumes/index.mdx +++ b/tutorials/encrypt-volumes/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-08 posted: 2019-02-04 --- +import Requirements from '@macros/iam/requirements.mdx' + To protect sensitive commercial or client data stored on your Instances, encryption is paramount. The repercussions of such data falling into unauthorized hands can be detrimental to your business. @@ -20,7 +22,7 @@ Encrypting the entire volume is the optimal strategy, alleviating concerns about By using this method, all sensitive information can reside on an encrypted volume, fortified by an extra layer of security. This tutorial will walk you through the process of encrypting an additional volume using [Cryptsetup](https://gitlab.com/cryptsetup/cryptsetup/) with [LUKS](https://en.wikipedia.org/wiki/Linux_Unified_Key_Setup), a universally recognized on-disk format employed in various encryption tools. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/export-audit-trail-to-datadog/index.mdx b/tutorials/export-audit-trail-to-datadog/index.mdx index 1868db2c32..408013b0db 100644 --- a/tutorials/export-audit-trail-to-datadog/index.mdx +++ b/tutorials/export-audit-trail-to-datadog/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-02-10 posted: 2025-02-10 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial shows you how to export your Audit Trail events to [DataDog](https://www.datadoghq.com/). For the purpose of this tutorail, we are building a [custom OpenTelemetry Collector](https://opentelemetry.io/docs/collector/custom-collector/) to collect Audit Trail events through the [Audit Trail receiver](https://github.com/scaleway/opentelemetry-collector-scaleway/tree/main/receiver/scwaudittrail) and export them with the [DataDog exporter](https://github.com/open-telemetry/opentelemetry-collector-contrib/tree/main/exporter/datadogexporter). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/first-steps-linux-command-line/index.mdx b/tutorials/first-steps-linux-command-line/index.mdx index 7376119e91..21b77422b8 100644 --- a/tutorials/first-steps-linux-command-line/index.mdx +++ b/tutorials/first-steps-linux-command-line/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-06-02 posted: 2023-11-16 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial shows you how to get started with the Linux command line (also known as the **terminal**). @@ -35,7 +37,7 @@ In this document, we cover commands for a **Linux** command line. If you are usi If you are just looking for a quick recap and cheatsheet of Linux commands you are already familiar with, [skip to the last section](#linux-commands-summary-and-cheatsheet). - + - Provisioned a virtual/remote machine running a Linux OS and [connected to its command line via SSH](/instances/how-to/connect-to-instance/) or you are using a physical machine running a Linux OS or MacOS, and have opened the terminal. diff --git a/tutorials/flask/index.mdx b/tutorials/flask/index.mdx index f75923b1ad..c7da4686bf 100644 --- a/tutorials/flask/index.mdx +++ b/tutorials/flask/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-04-08 posted: 2018-08-23 --- +import Requirements from '@macros/iam/requirements.mdx' + Flask is a web application framework written in Python. Flask is easy to get started with as a beginner because there is little boilerplate code for getting a simple app up and running. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/focalboard-project-management/index.mdx b/tutorials/focalboard-project-management/index.mdx index 8fe9f380cc..86bc920d5b 100644 --- a/tutorials/focalboard-project-management/index.mdx +++ b/tutorials/focalboard-project-management/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2023-02-22 --- +import Requirements from '@macros/iam/requirements.mdx' + Developed by Mattermost, Focalboard emerges as an open-source and multilingual project management solution that readily accommodates self-hosting. Its central objective revolves around equipping organizations with a unified reference point, fostering team alignment and dedication to task completion, milestones, and objectives. @@ -24,7 +26,7 @@ In short, if you are seeking a robust and budget-friendly project management sol We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/production-optimized/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/foreman-puppet/index.mdx b/tutorials/foreman-puppet/index.mdx index 4f7cb16040..a0050e4940 100644 --- a/tutorials/foreman-puppet/index.mdx +++ b/tutorials/foreman-puppet/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2018-08-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Foreman is a tool that helps system administrators manage servers throughout their lifecycle, from provisioning and configuration to orchestration and monitoring. In short, it is a complete lifecycle management tool for physical and virtual servers. Foreman, available as open source software, becomes even more powerful when integrated with other open source projects such as [Puppet](https://puppet.com/ecosystem/devx/), [Chef](/tutorials/configure-chef-ubuntu-xenial/), [Salt](https://docs.saltstack.com/en/latest/), and [Ansible](/tutorials/ansible-bionic-beaver/). @@ -19,7 +21,7 @@ Foreman helps to automatize the OS installation. After that, through its integra This tutorial assumes that Foreman is being installed on a fresh Instance, which will also act as the Puppet primary server. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/get-started-containers-docker/index.mdx b/tutorials/get-started-containers-docker/index.mdx index 61c109a5bd..91125c45c3 100644 --- a/tutorials/get-started-containers-docker/index.mdx +++ b/tutorials/get-started-containers-docker/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-04-22 posted: 2022-04-07 --- +import Requirements from '@macros/iam/requirements.mdx' + This is the first in a series of tutorials accompanying our [video demonstrations on getting started with Kubernetes](https://www.youtube.com/watch?v=zgxcCcKnXR0). In this first tutorial, we focus on one of the fundamental concepts behind Kubernetes: the [container](/serverless-containers/concepts/#container). We use the popular containerization platform [Docker](https://www.docker.com/) to create and deploy a simple containerized "Hello World" application, before moving on to look at a slightly more complex application example. We finish by pushing the container images we have created to the Scaleway [Container Registry](/container-registry/concepts/#container-registry). Future videos and tutorials in this series will show you how to then deploy your containerized application with Kubernetes, specifically with the Scaleway [Kubernetes Kapsule](/kubernetes/concepts/#kubernetes-kapsule). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/get-started-crossplane-kubernetes/index.mdx b/tutorials/get-started-crossplane-kubernetes/index.mdx index 55e72c85e5..39966f3e76 100644 --- a/tutorials/get-started-crossplane-kubernetes/index.mdx +++ b/tutorials/get-started-crossplane-kubernetes/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-06-02 posted: 2023-05-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Created by Upbound, [Crossplane](https://www.crossplane.io/) is a Kubernetes-based platform that allows you to manage resources through a unified control plane. `crossplane-provider-scaleway` is a Crossplane provider that helps you manage Scaleway cloud resources in Kubernetes. It is built using [Upjet](https://github.com/upbound/upjet) code generation tools and it exposes managed resources for Scaleway that adhere to Crossplane's eXtensible Resource Model (XRM). As a model, XRM ensures that users can easily and consistently manage cloud resources across different cloud providers. In this tutorial, you will learn how to install Upbound Universal Crossplane (UXP) into your Kubernetes cluster, configure the provider to authenticate with Scaleway, and create a Scaleway [Kubernetes](/kubernetes/quickstart/) managed resource directly from your cluster. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/get-started-deploy-kapsule/index.mdx b/tutorials/get-started-deploy-kapsule/index.mdx index a56ddfd9b2..5ddabe4795 100644 --- a/tutorials/get-started-deploy-kapsule/index.mdx +++ b/tutorials/get-started-deploy-kapsule/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-02 posted: 2022-05-05 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial accompanies the second [video demonstration](https://www.youtube.com/watch?v=R5CwAq1a0Og) in our series to help users get started with Kubernetes. We walk you through Kubernetes fundamentals for beginners. In this installment, we show you how to deploy a containerized application with the [Scaleway Kubernetes Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/). @@ -21,7 +23,7 @@ We then demonstrate how to deploy the containerized application (via the `whoami Future videos will cover topics like load balancing and storage for your Kubernetes application. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/get-started-kubernetes-loadbalancer/index.mdx b/tutorials/get-started-kubernetes-loadbalancer/index.mdx index b94961b765..967dad82b1 100644 --- a/tutorials/get-started-kubernetes-loadbalancer/index.mdx +++ b/tutorials/get-started-kubernetes-loadbalancer/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2023-09-19 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/get-started-kubernetes-storage/index.mdx b/tutorials/get-started-kubernetes-storage/index.mdx index 6ba6af318e..ebde55302d 100644 --- a/tutorials/get-started-kubernetes-storage/index.mdx +++ b/tutorials/get-started-kubernetes-storage/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-02-11 posted: 2024-01-29 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial accompanies the fourth [video demonstration](https://www.youtube.com/watch?v=OAR_3Fuwtw0) in our series to help users get started with Kubernetes. We walk you through Kubernetes fundamentals for beginners. In this installment, we show you how to add storage to your [Scaleway Kubernetes Kapsule](https://www.scaleway.com/en/kubernetes-kapsule/). @@ -19,7 +21,7 @@ First, we address the question of why we might need to add storage to our cluste Previous videos in this series covered the basics of [containers and Docker](/tutorials/get-started-containers-docker/), [deploying an app with Kapsule](/tutorials/get-started-deploy-kapsule/), and [adding a Load Balancer](/tutorials/get-started-kubernetes-loadbalancer/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/getting-started-with-kops-on-scaleway/index.mdx b/tutorials/getting-started-with-kops-on-scaleway/index.mdx index cdc8e1221b..9d071fe75c 100644 --- a/tutorials/getting-started-with-kops-on-scaleway/index.mdx +++ b/tutorials/getting-started-with-kops-on-scaleway/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2023-03-23 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + kOps is a tool that helps you set up and manage Kubernetes clusters for production use. It is like a version of `kubectl` specifically designed for managing clusters. @@ -22,7 +24,7 @@ With kOps, you can easily create, upgrade, and maintain highly available cluster Scaleway support on kOps is currently in **alpha**, which means that it is in the early stages of development and subject to change. Use it with caution. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/gitlab-instant-app/index.mdx b/tutorials/gitlab-instant-app/index.mdx index 936599dc88..a55ee5c76b 100644 --- a/tutorials/gitlab-instant-app/index.mdx +++ b/tutorials/gitlab-instant-app/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-02 posted: 2015-05-07 --- +import Requirements from '@macros/iam/requirements.mdx' + This guide explains the usage of the GitLab repository manager InstantApp, on a Scaleway Instance. GitLab is a web-based platform designed for managing Git repositories and provides a wide range of features, including code reviews, wikis, and issue tracking. Scaleway provides a GitLab image that is built on Ubuntu 22.04 LTS (Jammy Jellyfish) and includes GitLab version 16.3.3. By default, this image includes support for [routed IPs](/instances/api-cli/using-routed-ips/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/glpi/index.mdx b/tutorials/glpi/index.mdx index d0e14ae016..1fc466453a 100644 --- a/tutorials/glpi/index.mdx +++ b/tutorials/glpi/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-08 posted: 2020-08-13 --- +import Requirements from '@macros/iam/requirements.mdx' + Gestionnaire Libre de Parc Informatique (GLPI), or Open Source IT Equipment Manager in English, is a web-based asset and IT management open-source software, written in PHP and released under the GNU General Public License. A graphic interface, accessible via web-browser, allows users to easily operate IT operations, that can include hardware from peripherals to entire server racks. @@ -26,7 +28,7 @@ The application disposes of several features to assist companies in managing the - Statistics and reports - Knowledge base - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/glusterfs/index.mdx b/tutorials/glusterfs/index.mdx index e0830d1c24..2b5d57defb 100644 --- a/tutorials/glusterfs/index.mdx +++ b/tutorials/glusterfs/index.mdx @@ -12,13 +12,15 @@ dates: validation: 2025-05-02 posted: 2018-09-28 --- +import Requirements from '@macros/iam/requirements.mdx' + GlusterFS is an open-source, scalable network file system suited for high data-intensive workloads, such as media streaming, cloud storage, and content delivery networks (CDN). In this tutorial, we will deploy a high-availability storage solution using **GlusterFS 11** and **Scaleway Block Storage** on **Ubuntu 22.04**. Each storage Instance will mirror the other, and files will automatically be replicated across all servers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/gpu-super-resolution/index.mdx b/tutorials/gpu-super-resolution/index.mdx index 639778adac..626ddb1bf6 100644 --- a/tutorials/gpu-super-resolution/index.mdx +++ b/tutorials/gpu-super-resolution/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2020-09-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Super-resolution is the process of enhancing the details of a low-resolution image to recover a high-resolution image. In the context of deep learning, the technique consists of taking a low-resolution image as input, passing it through a neural network, and receiving an output that is a higher-resolution version of the input. @@ -23,7 +25,7 @@ After the model has been trained, a separate test set should be used to guarante In this tutorial, we will show you how to prepare your data, construct the **sub-pixel convolutional** neural network, train it, and test it using a Scaleway [GPU instance](https://console.scaleway.com/instance/servers/create). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/hadoop/index.mdx b/tutorials/hadoop/index.mdx index 06bd4e8870..1ba76e1a30 100644 --- a/tutorials/hadoop/index.mdx +++ b/tutorials/hadoop/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2018-08-29 --- +import Requirements from '@macros/iam/requirements.mdx' + Hadoop is an open-source framework. It is provided by Apache to process and analyze large volumes of data. It is written in Java and is currently used by Google, Facebook, LinkedIn, Yahoo, Twitter, etc. @@ -32,7 +34,7 @@ Hadoop is comprised of four main layers: For more information, refer to the [official Apache Hadoop documentation.](http://hadoop.apache.org/#What+Is+Apache+Hadoop%3F) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/hestiacp/index.mdx b/tutorials/hestiacp/index.mdx index 8e84ee2330..cf2cecde66 100644 --- a/tutorials/hestiacp/index.mdx +++ b/tutorials/hestiacp/index.mdx @@ -11,6 +11,8 @@ dates: validation: 2025-04-22 posted: 2020-07-07 --- +import Requirements from '@macros/iam/requirements.mdx' + HestiaCP is an open-source control panel that provides easy-to-use web and command line interfaces that allow web server administrators to manage domain names, web spaces, mail accounts, and DNS zones from a centralized location with ease and without the need to manually edit configuration files. @@ -18,7 +20,7 @@ The project is a fork of the existing Vesta control panel and is currently in ac In this tutorial, you will learn how to install and configure HestiaCP on Ubuntu 18.04 (Bionic Beaver). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/host-github-runner/index.mdx b/tutorials/host-github-runner/index.mdx index 7108a8a7ea..7fac46e552 100644 --- a/tutorials/host-github-runner/index.mdx +++ b/tutorials/host-github-runner/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2018-04-06 --- +import Requirements from '@macros/iam/requirements.mdx' + GitHub Actions stands as a versatile tool, simplifying the automation of all your software workflows. This integrated CI/CD solution handles an extensive array of tasks tied to your repository. @@ -23,7 +25,7 @@ In this guide, you will learn how to configure a GitHub Actions runner on a Scal We recommend you follow this tutorial using a [Cost-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/how-to-implement-rag-generativeapis/index.mdx b/tutorials/how-to-implement-rag-generativeapis/index.mdx index 27cb15da4b..9695e0b0b3 100644 --- a/tutorials/how-to-implement-rag-generativeapis/index.mdx +++ b/tutorials/how-to-implement-rag-generativeapis/index.mdx @@ -11,6 +11,8 @@ dates: categories: - generative-apis --- +import Requirements from '@macros/iam/requirements.mdx' + Retrieval-Augmented Generation (RAG) enhances language models by incorporating relevant information from your own datasets. This hybrid approach improves both the accuracy and contextual relevance of the model's outputs, making it ideal for advanced AI applications. @@ -21,7 +23,7 @@ In this tutorial, you will learn how to implement RAG using LangChain, a leading - How to store and query embeddings using ***Scaleway’s Managed PostgreSQL Database*** with pgvector - How to manage large datasets efficiently with ***Scaleway Object Storage*** - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/how-to-implement-rag/index.mdx b/tutorials/how-to-implement-rag/index.mdx index a7aa528ecb..c0e4537782 100644 --- a/tutorials/how-to-implement-rag/index.mdx +++ b/tutorials/how-to-implement-rag/index.mdx @@ -8,6 +8,8 @@ tags: inference managed postgresql pgvector object storage RAG langchain machine categories: - managed-inference --- +import Requirements from '@macros/iam/requirements.mdx' + Retrieval-Augmented Generation (RAG) supercharges language models by enabling real-time retrieval of relevant information from external datasets. This hybrid approach boosts both the accuracy and contextual relevance of model outputs, making it essential for advanced AI applications. @@ -21,7 +23,7 @@ LangChain simplifies the process of enhancing language models with retrieval cap - How to store and query embeddings using ***Scaleway’s Managed PostgreSQL Database*** with pgvector - How to manage large datasets efficiently with ***Scaleway Object Storage*** - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-apache-ansible/index.mdx b/tutorials/install-apache-ansible/index.mdx index e5d49f426f..574b6d5c68 100644 --- a/tutorials/install-apache-ansible/index.mdx +++ b/tutorials/install-apache-ansible/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-01-22 posted: 2018-08-02 --- +import Requirements from '@macros/iam/requirements.mdx' + Apache is one of the most used open-source web servers globally. This tutorial explains how to deploy and configure Apache on Scaleway Instances with the power of Ansible automation. Before diving in, ensure you meet the prerequisites: - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - Familiarity with [Ansible](/tutorials/ansible-bionic-beaver/) for seamless execution diff --git a/tutorials/install-cassandra/index.mdx b/tutorials/install-cassandra/index.mdx index 34d2f24f95..fadd1dd286 100644 --- a/tutorials/install-cassandra/index.mdx +++ b/tutorials/install-cassandra/index.mdx @@ -12,11 +12,13 @@ dates: validation: 2025-04-08 posted: 2018-10-20 --- +import Requirements from '@macros/iam/requirements.mdx' + [Apache Cassandra](http://cassandra.apache.org/) is a replicated [NoSQL](https://en.wikipedia.org/wiki/NoSQL) database and an ideal solution for situations that require maximum data redundancy, uptime, and horizontal scaling across multiple servers. It is an open-source application that can easily be managed from a simple command-line interface using [Cassandra Query Language (CQL)](https://cassandra.apache.org/doc/latest/cql/) which is very similar to Structured Query Language, making it easy to learn for users that are already firm with SQL. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-cockroachdb-scaleway-instances/index.mdx b/tutorials/install-cockroachdb-scaleway-instances/index.mdx index 778e621df0..144e121d6d 100644 --- a/tutorials/install-cockroachdb-scaleway-instances/index.mdx +++ b/tutorials/install-cockroachdb-scaleway-instances/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2023-10-02 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + CockroachDB is an open-source, distributed SQL database designed to be scalable, reliable, and consistent. @@ -24,7 +26,7 @@ Thanks to its serializable SQL transactions, CockroachDB also ensures that data This article shows you how to install CockroachDB using three nodes on a Private Network as well as a Scaleway Load Balancer to access the database and console. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-configure-couchdb/index.mdx b/tutorials/install-configure-couchdb/index.mdx index 030ebc67fe..3f7513d988 100644 --- a/tutorials/install-configure-couchdb/index.mdx +++ b/tutorials/install-configure-couchdb/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2018-07-25 --- +import Requirements from '@macros/iam/requirements.mdx' + Apache CouchDB is an open-source database solution that was built with ease of use and scalability in mind. It is a database that completely embraces the web. It allows you to store your data with JSON documents and to access these documents with your web browser. @@ -25,7 +27,7 @@ CouchDB uses a form of [multiversion concurrency control (MVCC)](https://en.wiki CouchDB also supports multi-primary replication which allows it to scale across multiple machines to build high-performance systems. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-docker-ubuntu-bionic/index.mdx b/tutorials/install-docker-ubuntu-bionic/index.mdx index 0b8939c801..0b041177d0 100644 --- a/tutorials/install-docker-ubuntu-bionic/index.mdx +++ b/tutorials/install-docker-ubuntu-bionic/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-08 posted: 2018-07-11 --- +import Requirements from '@macros/iam/requirements.mdx' + Docker is a tool designed to create, deploy, and run applications using containers. @@ -20,7 +22,7 @@ Containers allow packing an application with all requirements necessary, such as This ensures that an application can run on any Linux machine, regardless of the specific settings of the host machine, which might be different from the development environment. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-docker-ubuntu-jammy-jellyfish/index.mdx b/tutorials/install-docker-ubuntu-jammy-jellyfish/index.mdx index 7b454cc752..ec82ff4aaa 100644 --- a/tutorials/install-docker-ubuntu-jammy-jellyfish/index.mdx +++ b/tutorials/install-docker-ubuntu-jammy-jellyfish/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-02-18 posted: 2023-08-01 --- +import Requirements from '@macros/iam/requirements.mdx' + Docker is a powerful and widely used open-source platform that enables developers to automate the deployment, scaling, and management of applications consistently and efficiently. @@ -24,7 +26,7 @@ Docker Engine is the core component of the [Docker platform](https://docs.docker * **Docker Compose**: Docker Compose is a tool that allows you to define and manage multi-container applications using a YAML file. It simplifies the process of defining the services, networks, and volumes required for your application stack. * **Containerd**: containerd is an open-source container runtime that serves as the industry-standard container runtime interface (CRI) between higher-level container management systems (such as Docker and Kubernetes) and the low-level kernel features responsible for running containers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-github-actions-runner-mac/index.mdx b/tutorials/install-github-actions-runner-mac/index.mdx index de8fa6c16e..353c6902a9 100644 --- a/tutorials/install-github-actions-runner-mac/index.mdx +++ b/tutorials/install-github-actions-runner-mac/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-19 posted: 2024-01-31 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-golang-ubuntu-bionic/index.mdx b/tutorials/install-golang-ubuntu-bionic/index.mdx index dba5798f6d..009f464ad3 100644 --- a/tutorials/install-golang-ubuntu-bionic/index.mdx +++ b/tutorials/install-golang-ubuntu-bionic/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2018-08-14 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + [Go](https://go.dev/) is an open-source programming language, initially developed by a team at Google and becoming increasingly popular for many applications. The project is backed by many contributors from the open-source community. This tutorial will guide you through the download and installation of the Go programming language on a Ubuntu Bionic Beaver server. At the end of this guide, you will create your first Go application. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-ispconfig/index.mdx b/tutorials/install-ispconfig/index.mdx index ca97400a52..102ceadb74 100644 --- a/tutorials/install-ispconfig/index.mdx +++ b/tutorials/install-ispconfig/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-01-02 posted: 2019-01-25 --- +import Requirements from '@macros/iam/requirements.mdx' + ISPConfig is an open-source, transparent, free, stable, and secure administration tool, available in more than 20 languages. ISPConfig simplifies the management of various web hosting services such as DNS configuration, domain name management, email, or FTP file transfer. It can be used to manage a single server, multiple servers for larger setups, or even mirrored clusters. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-kvm-elastic-metal/index.mdx b/tutorials/install-kvm-elastic-metal/index.mdx index 89266320d6..832f20d267 100644 --- a/tutorials/install-kvm-elastic-metal/index.mdx +++ b/tutorials/install-kvm-elastic-metal/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-07-02 posted: 2019-05-10 --- +import Requirements from '@macros/iam/requirements.mdx' + KVM or Kernel-based Virtual Machine is a complete open-source virtualization solution for Linux on x86 hardware. It supports CPUs that come with virtualization extensions (Intel VT or AMD-V). @@ -22,7 +24,7 @@ Each virtual machine has virtualized devices such as: - a disk - a graphics adapter, etc. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-mattermost/index.mdx b/tutorials/install-mattermost/index.mdx index 3cbf6a707e..a98453e0c7 100644 --- a/tutorials/install-mattermost/index.mdx +++ b/tutorials/install-mattermost/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-02-18 posted: 2019-01-22 --- +import Requirements from '@macros/iam/requirements.mdx' + Mattermost is an open-source messaging tool for inter-team communication, released under the MIT license and available both in a free team and paid enterprise edition. This tutorial will show you how to install a Mattermost instance with an NGINX frontend proxy and a MariaDB database. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-medusa/index.mdx b/tutorials/install-medusa/index.mdx index 7913453b48..94f75341be 100644 --- a/tutorials/install-medusa/index.mdx +++ b/tutorials/install-medusa/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-06-02 posted: 2023-05-10 --- +import Requirements from '@macros/iam/requirements.mdx' + MedusaJS is a headless e-commerce platform built on Node.js and React that allows you to create scalable and powerful e-commerce solutions for your business. The platform is a powerful and adaptable tool that offers a range of customization and integration, as well as extensibility features. This tutorial will show you how to install and use MedusaJS, create a new project, start the development server, and customize your project. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-openlitespeed-wordpress/index.mdx b/tutorials/install-openlitespeed-wordpress/index.mdx index 9622df5961..786687d067 100644 --- a/tutorials/install-openlitespeed-wordpress/index.mdx +++ b/tutorials/install-openlitespeed-wordpress/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-02 posted: 2019-08-07 --- +import Requirements from '@macros/iam/requirements.mdx' + OpenLiteSpeed combines speed, security, scalability, optimization, and simplicity in one friendly open-source package. The source code of the project is released under the GPLv3 license and available publicly on [GitHub](https://github.com/litespeedtech/openlitespeed). The application provides a web-based administration interface, compatibility with Apache rewrite rules, as well as customized [PHP](https://php.net) processing for improved performance. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-openvpn/index.mdx b/tutorials/install-openvpn/index.mdx index fc97a3a857..2575622b7b 100644 --- a/tutorials/install-openvpn/index.mdx +++ b/tutorials/install-openvpn/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-01-06 posted: 2019-01-16 --- +import Requirements from '@macros/iam/requirements.mdx' + Learn how to install and configure OpenVPN on Ubuntu 24.04 LTS with this comprehensive guide. Follow our step-by-step instructions to establish a secure VPN connection via your Scaleway Instance with ease. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-parse-server/index.mdx b/tutorials/install-parse-server/index.mdx index 1949429ab8..d40f707baf 100644 --- a/tutorials/install-parse-server/index.mdx +++ b/tutorials/install-parse-server/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-06-19 posted: 2020-11-03 --- +import Requirements from '@macros/iam/requirements.mdx' + Parse provides a cloud-based backend service to build data-driven mobile applications quickly. Initially developed by Facebook, [Parse](https://parseplatform.org/) is a free and open-source Backend-as-a-Service (BaaS) platform that can be deployed to any infrastructure that runs [NodeJS](https://nodejs.org/en/). It can be added to existing web applications, or run by itself. Parse server comes with a simple and easy-to-use web interface that can be used for data manipulation, analytics, and scheduling and sending push notifications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-pgbouncer/index.mdx b/tutorials/install-pgbouncer/index.mdx index 3b8571af90..45bdc7b30b 100644 --- a/tutorials/install-pgbouncer/index.mdx +++ b/tutorials/install-pgbouncer/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-19 posted: 2022-02-24 --- +import Requirements from '@macros/iam/requirements.mdx' + [PgBouncer](https://www.pgbouncer.org/) is a connection pooler for [PostgreSQL](https://www.postgresql.org/). It sits between the application and the PostgreSQL server. PgBouncer opens multiple connections to the database and serves it to the application. This reduces connection opening costs for the application and gives a performance boost. @@ -23,7 +25,7 @@ There are three types of pooling modes: In this tutorial, you can choose the pooling mode that best suits your workload. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-php-composer/index.mdx b/tutorials/install-php-composer/index.mdx index ce53a8475c..4bf211627d 100644 --- a/tutorials/install-php-composer/index.mdx +++ b/tutorials/install-php-composer/index.mdx @@ -14,10 +14,12 @@ dates: posted: 2018-01-29 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + PHP Composer is a package dependency management tool for PHP similar to NPM for Node.js and a bundle for Ruby. Composer facilitates the installation and updates for project dependencies. In short, Composer will pull in all the required PHP packages your project depends on and manage them for you. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-postgresql/index.mdx b/tutorials/install-postgresql/index.mdx index 19d2632f37..5e32a9d8f1 100644 --- a/tutorials/install-postgresql/index.mdx +++ b/tutorials/install-postgresql/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-07-02 posted: 2018-08-24 --- +import Requirements from '@macros/iam/requirements.mdx' + PostgreSQL is a mature and advanced open-source relational database system. With more than 30 years of active development, the software has earned a strong reputation for reliability, feature robustness, and performance. It runs on all major operating systems, including Linux, different Unix variants, macOS X and Windows. This tutorial describes how to run PostgreSQL on a server running Ubuntu. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-rkhunter/index.mdx b/tutorials/install-rkhunter/index.mdx index ee49f6e4c6..861864babe 100644 --- a/tutorials/install-rkhunter/index.mdx +++ b/tutorials/install-rkhunter/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-06-02 posted: 2018-10-30 --- +import Requirements from '@macros/iam/requirements.mdx' + The Rootkit Hunter (`rkhunter`) project provides an open-source tool to scan Unix installations for [rootkits](https://en.wikipedia.org/wiki/Rootkit), [backdoors]() and possible [local exploits](). To achieve this, the tool compares SHA-1 hashes of important files with known good ones in online databases, looking for default directories (of rootkits), wrong permissions, hidden files, and suspicious strings in kernel modules, and by running special tests on the computer. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/install-wireguard/index.mdx b/tutorials/install-wireguard/index.mdx index c14aecd3ee..0c862bf7c0 100644 --- a/tutorials/install-wireguard/index.mdx +++ b/tutorials/install-wireguard/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2019-03-28 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/installation-jekyll/index.mdx b/tutorials/installation-jekyll/index.mdx index 937f2f27e8..32cd61aa42 100644 --- a/tutorials/installation-jekyll/index.mdx +++ b/tutorials/installation-jekyll/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2018-07-12 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Jekyll is a powerful tool built with Ruby, designed to convert MarkDown files into static websites. Unlike server-side languages such as PHP, which generates a new page for each visitor, Jekyll takes a different approach. It transforms your MarkDown content into static HTML files, minimizing RAM and CPU usage. This method ensures that your web pages are pre-generated, providing a faster and resource-friendly solution. In this guide, we'll dive into how Jekyll simplifies the process of creating static websites, offering a more streamlined and performance-conscious alternative. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/installation-lemp-ubuntu-bionic/index.mdx b/tutorials/installation-lemp-ubuntu-bionic/index.mdx index 5bb41cb809..e4f6e0aab5 100644 --- a/tutorials/installation-lemp-ubuntu-bionic/index.mdx +++ b/tutorials/installation-lemp-ubuntu-bionic/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2018-07-31 --- +import Requirements from '@macros/iam/requirements.mdx' + The LEMP-Stack references a group of software that can be used to serve dynamic web applications and websites. **LEMP** is an acronym and stands for: @@ -20,7 +22,7 @@ The LEMP-Stack references a group of software that can be used to serve dynamic - A [MySQL](https://www.mysql.com/) (or [MariaDB](https://mariadb.org/), which is a drop-in fork of MySQL) database server - [PHP](http://www.php.net/) for dynamic data processing - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/installation-lemp-ubuntu-focal/index.mdx b/tutorials/installation-lemp-ubuntu-focal/index.mdx index 8b22d37058..f836128b86 100644 --- a/tutorials/installation-lemp-ubuntu-focal/index.mdx +++ b/tutorials/installation-lemp-ubuntu-focal/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2021-12-03 --- +import Requirements from '@macros/iam/requirements.mdx' + The LEMP-Stack references a group of software that can be used to serve dynamic web applications and websites. **LEMP** is an acronym and stands for: @@ -20,7 +22,7 @@ The LEMP-Stack references a group of software that can be used to serve dynamic - A [MySQL](https://www.mysql.com/) (or [MariaDB](https://mariadb.org/), which is a drop-in fork of MySQL) database server - [PHP](http://www.php.net/) for dynamic data processing - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/installation-uncomplicated-firewall/index.mdx b/tutorials/installation-uncomplicated-firewall/index.mdx index e389672ea9..85ce003a9c 100644 --- a/tutorials/installation-uncomplicated-firewall/index.mdx +++ b/tutorials/installation-uncomplicated-firewall/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-30 posted: 2018-07-18 --- +import Requirements from '@macros/iam/requirements.mdx' + A firewall controls incoming and outgoing network traffic based on predefined security rules. Typically, it establishes a barrier between a trusted (internal) network and an untrusted external network, like the internet. UFW, or **[Uncomplicated FireWall](https://en.wikipedia.org/wiki/Uncomplicated_Firewall)**, is a frontend for [IPTables](https://en.wikipedia.org/wiki/Iptables) to simplify the configuration of your firewall. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/jitsi-debian/index.mdx b/tutorials/jitsi-debian/index.mdx index 7a0eda9512..f7e980b08b 100644 --- a/tutorials/jitsi-debian/index.mdx +++ b/tutorials/jitsi-debian/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2020-03-16 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Jitsi Meet is a fully encrypted, open-source video conferencing tool that does not require an account or subscription. @@ -23,7 +25,7 @@ The tool provides features such as: * editing documents together using Etherpad * integrated chat - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/jitsi-docker/index.mdx b/tutorials/jitsi-docker/index.mdx index f5e744ee6b..cb22a6c887 100644 --- a/tutorials/jitsi-docker/index.mdx +++ b/tutorials/jitsi-docker/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-30 posted: 2020-03-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Jitsi Meet is a fully encrypted, open-source video conferencing tool. You do not need an account or subscription to use it. The solution can be installed natively on [Ubuntu Bionic Beaver (18.04 LTS)](/tutorials/jitsi-ubuntu-bionic/) and [Debian Buster](/tutorials/jitsi-debian/). You can also install it using a containerized application running on [Docker](https://www.docker.com/). This tutorial explains how to install the Jitsi Meet solution on an Instance using the [Docker Image](https://github.com/jitsi/docker-jitsi-meet) provided by the Jitsi team, allowing you to deploy your personal Jitsi Meet video conferencing solution in a few easy steps. It is based on a Debian stable base installation and provides all additional modules available for Jitsi like [Etherpad](https://etherpad.org/) or [jigasi](https://github.com/jitsi/jigasi), a gateway allowing SIP connections to the Jitsi Meet Instance. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/jitsi-ubuntu-jammy-jellyfish/index.mdx b/tutorials/jitsi-ubuntu-jammy-jellyfish/index.mdx index eedd9b7766..04273c9d62 100644 --- a/tutorials/jitsi-ubuntu-jammy-jellyfish/index.mdx +++ b/tutorials/jitsi-ubuntu-jammy-jellyfish/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-06-19 posted: 2022-11-16 --- +import Requirements from '@macros/iam/requirements.mdx' + Jitsi Meet is a robust and fully encrypted open-source video conferencing tool, eliminating the need for subscriptions or account creation. This user-friendly platform goes beyond the basics, providing an extensive set of features to enhance your virtual meetings. @@ -26,7 +28,7 @@ With Jitsi Meet, you can enjoy: Jitsi Meet provides users with a complete suite of tools, making virtual meetings not only secure but also dynamic and collaborative. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/jump-desktop/index.mdx b/tutorials/jump-desktop/index.mdx index 1be8af9e82..7cd0904cac 100644 --- a/tutorials/jump-desktop/index.mdx +++ b/tutorials/jump-desktop/index.mdx @@ -12,6 +12,8 @@ hero: assets/scaleway_jump_desktop.webp dates: validation: 2025-05-26 --- +import Requirements from '@macros/iam/requirements.mdx' + Jump Desktop is a secure and reliable remote desktop infrastructure that lets you connect to any computer, anywhere in the world without VPNs or gateways. Jump Desktop is designed to work perfectly on iOS, Mac, Windows, and Android devices. @@ -19,7 +21,7 @@ Scaleway's Apple silicon as-a-Service offer is highly compatible with Jump Deskt In this tutorial, you will learn how to launch your Mac mini development environment on Jump Desktop. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/k8s-gitlab/index.mdx b/tutorials/k8s-gitlab/index.mdx index 970baab8cc..3ec1ee9b0c 100644 --- a/tutorials/k8s-gitlab/index.mdx +++ b/tutorials/k8s-gitlab/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-01-02 posted: 2020-06-09 --- +import Requirements from '@macros/iam/requirements.mdx' + GitLab provides a built-in Kubernetes integration that allows you to build, test, deploy, and run your app at scale. In this tutorial, you will learn how to use the `gitlab` Kubernetes integration using a [Scaleway Instance](https://www.scaleway.com/en/virtual-instances/). The Instance will be deployed using the Scaleway `gitlab` InstantApp. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/k8s-kapsule-multi-az/index.mdx b/tutorials/k8s-kapsule-multi-az/index.mdx index 039cc00244..6ed658c985 100644 --- a/tutorials/k8s-kapsule-multi-az/index.mdx +++ b/tutorials/k8s-kapsule-multi-az/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-05-05 posted: 2023-04-15 --- +import Requirements from '@macros/iam/requirements.mdx' + Multi-AZ Kubernetes Kapsule is a configuration where a managed Kubernetes cluster is distributed across multiple isolated Availability Zones (AZs) within a Scaleway region, enhancing the resilience and availability of applications. This configuration allows the system to withstand failures in one zone by replicating resources and workloads across multiple zones. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A domain managed on the Scaleway [Domains and DNS service](/domains-and-dns/quickstart/) diff --git a/tutorials/k8s-velero-backup/index.mdx b/tutorials/k8s-velero-backup/index.mdx index cdd7f50f1a..d7f40bc3d3 100644 --- a/tutorials/k8s-velero-backup/index.mdx +++ b/tutorials/k8s-velero-backup/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-02 posted: 2023-06-02 --- +import Requirements from '@macros/iam/requirements.mdx' + Velero is an open-source utility designed to facilitate the backup, restoration, and migration of Kubernetes cluster resources and persistent volumes on Amazon S3-compatible Object Storage. Originally developed by Heptio, it became part of VMware following an acquisition. Velero offers a straightforward and effective approach to protecting your Kubernetes applications and data through regular backups and supporting disaster recovery measures. @@ -22,7 +24,7 @@ Beyond backups, Velero allows users to restore applications and data either with Velero seamlessly integrates with Kubernetes through custom resource definitions (CRDs) and operates as a deployment within the cluster. Leveraging plugins, Velero addresses various aspects of backup and restore operations, allowing for flexibility, extensibility, and customization. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/kubernetes-package-management-helm/index.mdx b/tutorials/kubernetes-package-management-helm/index.mdx index 61e8513fbf..c78efc9881 100644 --- a/tutorials/kubernetes-package-management-helm/index.mdx +++ b/tutorials/kubernetes-package-management-helm/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-06-02 posted: 2024-05-23 --- +import Requirements from '@macros/iam/requirements.mdx' + Helm is a package manager for Kubernetes that simplifies the deployment, management, and configuration of applications running on Kubernetes clusters, significantly enhancing Kubernetes' native capabilities. @@ -36,7 +38,7 @@ However, it also comes with its own set of disadvantages, which include: For a complete overview of Helm and its basic concepts, refer to this [Scaleway blog post](https://www.scaleway.com/en/blog/helm-guide/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/large-messages/index.mdx b/tutorials/large-messages/index.mdx index 9dc97aeb2f..5b299b7b08 100644 --- a/tutorials/large-messages/index.mdx +++ b/tutorials/large-messages/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-05-19 posted: 2024-01-22 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, we will build a simple architecture to store and automatically convert images to PDF. The focus is on transferring large messages using a messaging service, specifically the [Scaleway NATS](/nats/quickstart/) server. Our setup involves using the [Object Storage](/object-storage/quickstart/) service for image storage and the [Serverless Functions](/serverless-functions/quickstart/) service for conversion. @@ -21,7 +23,7 @@ We show how to provision all the required Scaleway resources via Terraform/OpenT You can retrieve the full source code in [this repository](https://github.com/rouche-q/serverless-examples/tree/main/projects/large-messages/README.md), so you can choose to either jump straight into the code or else follow along with the step-by-step explanation below to create the architecture yourself. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/lb-firewall-haproxy-pfsense/index.mdx b/tutorials/lb-firewall-haproxy-pfsense/index.mdx index 97188b7af8..ef2b60ba5b 100644 --- a/tutorials/lb-firewall-haproxy-pfsense/index.mdx +++ b/tutorials/lb-firewall-haproxy-pfsense/index.mdx @@ -15,6 +15,8 @@ dates: validation_frequency: 18 posted: 2020-03-11 --- +import Requirements from '@macros/iam/requirements.mdx' + ## pfSense Overview @@ -22,7 +24,7 @@ dates: This tutorial guides you through the installation of pfSense on a [Scaleway Dedibox](https://www.scaleway.com/en/dedibox/) server, the automatic configuration of failover IPs, and load balancing using HAProxy/Acme. It was written in collaboration with our community member [shannara](https://github.com/shannara). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/tutorials/librenms-monitoring/index.mdx b/tutorials/librenms-monitoring/index.mdx index 183974a9fb..6662850f86 100644 --- a/tutorials/librenms-monitoring/index.mdx +++ b/tutorials/librenms-monitoring/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-02 posted: 2019-07-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Learn how to use LibreNMS to monitor Instances on Ubuntu 24.04 (Noble Numbat). LibreNMS is an open-source network monitoring system supporting a wide range of network hardware and operating systems, including Linux and Windows. The software is based on PHP and MySQL (MariaDB) and is a community-based fork of the last GPL-licensed version of Observium. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/load-overflow-proxmox-and-elastic-metal/index.mdx b/tutorials/load-overflow-proxmox-and-elastic-metal/index.mdx index c676e5f1cb..206c984360 100644 --- a/tutorials/load-overflow-proxmox-and-elastic-metal/index.mdx +++ b/tutorials/load-overflow-proxmox-and-elastic-metal/index.mdx @@ -15,6 +15,8 @@ dates: validation: 2025-05-12 posted: 2019-05-20 --- +import Requirements from '@macros/iam/requirements.mdx' + ## Overview @@ -33,7 +35,7 @@ Each Elastic Metal server will then join this cluster. Subsequently, we can gene Finally, we can introduce and configure a Load Balancer to evenly distribute traffic among all VMs in the cluster. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/load-testing-vegeta/index.mdx b/tutorials/load-testing-vegeta/index.mdx index 5363ee78ad..a89fd57839 100644 --- a/tutorials/load-testing-vegeta/index.mdx +++ b/tutorials/load-testing-vegeta/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-19 posted: 2019-05-20 --- +import Requirements from '@macros/iam/requirements.mdx' + ## Vegeta load testing @@ -30,7 +32,7 @@ Before transitioning an application to a production environment, load testing he We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/loriot-lorawan-network-server/index.mdx b/tutorials/loriot-lorawan-network-server/index.mdx index 7c0f7e949c..a7cd97fab4 100644 --- a/tutorials/loriot-lorawan-network-server/index.mdx +++ b/tutorials/loriot-lorawan-network-server/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-07-02 posted: 2020-07-02 --- +import Requirements from '@macros/iam/requirements.mdx' + LoRaWAN© is a low-power, low-bandwidth, long-range radio protocol used by many devices to send their data over the air. This protocol is specifically designed for battery powered devices with little to no installation cost. @@ -26,7 +28,7 @@ In this tutorial we are going to: - Set up the Loriot backend to use the Device credentials to establish a connection with IoT Hub - Add another Device and connect it as a subscriber to receive LoRaWAN© messages - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/magento-ubuntu/index.mdx b/tutorials/magento-ubuntu/index.mdx index d9975fea2c..f8d231e145 100644 --- a/tutorials/magento-ubuntu/index.mdx +++ b/tutorials/magento-ubuntu/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-01-02 posted: 2020-06-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Magento is one of the most popular e-commerce systems available, with more than 100.000 online stores based on the platform. It is written in PHP and uses the Zend Framework. Database-wise it uses the MySQL or MariaDB relational database system. In this tutorial, you will learn how to install the open-source version of Magento on a Scaleway Instance running on Ubuntu Focal Fossa (20.04 LTS) or later. To support the tool, we will deploy a LAMP stack (Ubuntu Linux, Apache2, MariaDB, and PHP). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/manage-container-registry-images/index.mdx b/tutorials/manage-container-registry-images/index.mdx index d1b126b8e9..67b15a9908 100644 --- a/tutorials/manage-container-registry-images/index.mdx +++ b/tutorials/manage-container-registry-images/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-07-02 posted: 2021-10-11 --- +import Requirements from '@macros/iam/requirements.mdx' + With intensive use, a Container Registry can quickly become cluttered and store several outdated images. This tutorial will show you how to periodically remove older images with a specific tag using Serverless Functions, the Scaleway console, and Python's Urllib. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/manage-database-instance-pgadmin4/index.mdx b/tutorials/manage-database-instance-pgadmin4/index.mdx index 6881f69081..4b1a78efcf 100644 --- a/tutorials/manage-database-instance-pgadmin4/index.mdx +++ b/tutorials/manage-database-instance-pgadmin4/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-01-02 posted: 2019-10-28 --- +import Requirements from '@macros/iam/requirements.mdx' + pgAdmin is an open-source management tool for PostgreSQL databases. It allows the management of your [Scaleway Database Instances](https://www.scaleway.com/en/database/) and other PostgreSQL databases through an easy-to-use web-interface within your web browser. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/manage-instances-with-terraform-and-functions/index.mdx b/tutorials/manage-instances-with-terraform-and-functions/index.mdx index 362af09c2a..97745141d4 100644 --- a/tutorials/manage-instances-with-terraform-and-functions/index.mdx +++ b/tutorials/manage-instances-with-terraform-and-functions/index.mdx @@ -15,10 +15,12 @@ dates: validation: 2025-07-02 posted: 2021-12-21 --- +import Requirements from '@macros/iam/requirements.mdx' + HashiCorp Terraform/OpenTofu is an open-source software tool to deploy Infrastructure as Code (IaC). It allows you to automate the lifecycle of your Instances by using declarative configuration files. In this tutorial you will discover an example of Instance automation using Python and Terraform/OpenTofu (automatically shut down / start Instances). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/manage-k8s-logging-loki/index.mdx b/tutorials/manage-k8s-logging-loki/index.mdx index dc7077ba0c..7b0bcab7df 100644 --- a/tutorials/manage-k8s-logging-loki/index.mdx +++ b/tutorials/manage-k8s-logging-loki/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2019-11-06 --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule is fully integrated with Scaleway's [Observability Cockpit](/cockpit/quickstart/). @@ -23,7 +25,7 @@ In this tutorial, you will learn how to use **Loki** and **Grafana** to collect Loki is a log aggregation system inspired by **Prometheus**. It is easy to operate, as it does not index the content of the Kubernetes logs but sets labels for log streams. Your metadata (object labels) can be used in Loki for scraping Kubernetes logs. If you use Grafana for metrics, Loki will allow you to have a single point of management for both logging and monitoring. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mariadb-ubuntu-bionic/index.mdx b/tutorials/mariadb-ubuntu-bionic/index.mdx index b139e07086..a1adbaf4e1 100644 --- a/tutorials/mariadb-ubuntu-bionic/index.mdx +++ b/tutorials/mariadb-ubuntu-bionic/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2018-06-20 --- +import Requirements from '@macros/iam/requirements.mdx' + MariaDB is a fork of the MySQL (Structured Query Language) relational database management system which allows switching from MySQL to MariaDB without having to alter your applications since the data and data structures will not need to change. @@ -26,7 +28,7 @@ This means that: Even the command line tools are similar to `mysqldump` and `mysqladmin` still having the original names, allowing MariaDB to be a drop-in replacement. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mastodon-community/index.mdx b/tutorials/mastodon-community/index.mdx index 33d125d7ac..2b89b9b13b 100644 --- a/tutorials/mastodon-community/index.mdx +++ b/tutorials/mastodon-community/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2019-03-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Mastodon is an open-source, self-hosted, social media and social networking service. It allows you to host your Instances which may have their own code of conduct, terms of service, and moderation policies. There is no central server and Mastodon Instances are connected as a federated social network, allowing users from different Instances to interact with each other. The platform provides privacy features allowing users to adjust the privacy settings of each of their posts. @@ -20,7 +22,7 @@ As there is no central server, you can choose whether to join or leave an Instan Mastodon provides the possibility of using [Amazon S3-compatible Object Storage](/object-storage/how-to/create-a-bucket/) to store media content uploaded to Instances, making it flexible and scalable. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/matomo-analytics/index.mdx b/tutorials/matomo-analytics/index.mdx index fb2fad1874..5aa379c64e 100644 --- a/tutorials/matomo-analytics/index.mdx +++ b/tutorials/matomo-analytics/index.mdx @@ -14,12 +14,14 @@ dates: validation_frequency: 24 hero: assets/scaleway-matomo.webp --- +import Requirements from '@macros/iam/requirements.mdx' + [Matomo](https://matomo.org/) (former: Piwik) is an open-source web analytics platform designed to evaluate the visitor's behavior for one or multiple websites. The tool is written in PHP and stores its data in a MySQL/MariaDB database. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrate-data-minio-client/index.mdx b/tutorials/migrate-data-minio-client/index.mdx index fc673e7262..b3582d26c2 100644 --- a/tutorials/migrate-data-minio-client/index.mdx +++ b/tutorials/migrate-data-minio-client/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-03-27 posted: 2019-03-20 --- +import Requirements from '@macros/iam/requirements.mdx' + The [MinIO Client](https://min.io/docs/minio/linux/reference/minio-mc.html) provides a modern alternative to UNIX commands like ls, cat, cp, mirror, diff, etc. It can communicate with any Amazon S3-compatible cloud storage provider and can be used to migrate data from one region to another. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrate-data-rclone/index.mdx b/tutorials/migrate-data-rclone/index.mdx index 316e4a548b..f0cb3c572d 100644 --- a/tutorials/migrate-data-rclone/index.mdx +++ b/tutorials/migrate-data-rclone/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-04-01 posted: 2019-03-20 --- +import Requirements from '@macros/iam/requirements.mdx' + Rclone provides a modern alternative to `rsync`. The tool communicates with any Amazon S3-compatible cloud storage provider as well as other storage platforms and can be used to migrate data from one bucket to another, even if those buckets are in different regions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrate-databases-instance/index.mdx b/tutorials/migrate-databases-instance/index.mdx index 62f50ec8cd..b8d742b3d8 100644 --- a/tutorials/migrate-databases-instance/index.mdx +++ b/tutorials/migrate-databases-instance/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2020-09-21 --- +import Requirements from '@macros/iam/requirements.mdx' + [Managed Database for PostgreSQL and MySQL](https://www.scaleway.com/en/database/) product provides reliable high-performance managed SQL database engines, both for PostgreSQL and MySQL. Using the service allows you to stay focused on the development of your applications and to benefit from Scaleway's expertise in the management of your database engines. @@ -27,7 +29,7 @@ This guide consists of two parts, depending on which database Engine your Instan - Database migration for PostgreSQL - Database migration for MySQL - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrate-dedibox-to-elastic-metal/index.mdx b/tutorials/migrate-dedibox-to-elastic-metal/index.mdx index 459dea19ff..6527d49a88 100644 --- a/tutorials/migrate-dedibox-to-elastic-metal/index.mdx +++ b/tutorials/migrate-dedibox-to-elastic-metal/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-03-06 posted: 2022-01-25 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial provides step-by-step guidance for migrating your existing data from a Dedibox to an Elastic Metal server, ensuring improved stability, performance, and reliability. We use **Duplicity** to encrypt the backup and upload it to Object Storage. Then, we download and decrypt the data on the Elastic Metal server. - + ### Prerequisites - A Scaleway account logged into the [console](https://console.scaleway.com) diff --git a/tutorials/migrate-mysql-databases-postgresql-pgloader/index.mdx b/tutorials/migrate-mysql-databases-postgresql-pgloader/index.mdx index 374689fe8c..60ad698976 100644 --- a/tutorials/migrate-mysql-databases-postgresql-pgloader/index.mdx +++ b/tutorials/migrate-mysql-databases-postgresql-pgloader/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-22 posted: 2019-11-19 --- +import Requirements from '@macros/iam/requirements.mdx' + pgLoader is an open-source database migration tool developed to simplify the process of migrating an existing database from one database engine to [PostgreSQL](https://www.postgresql.org/). @@ -20,7 +22,7 @@ The tool supports migrations from several file types and database engines like [ In this tutorial, you learn how to migrate an existing remote MySQL database to a [Database for PostgreSQL](https://www.scaleway.com/en/database/) using pgLoader and an intermediate [Development Instance](https://www.scaleway.com/en/cost-optimized-instances/) running Ubuntu Linux. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrating-docker-workloads-to-kubernetes-kapsule/index.mdx b/tutorials/migrating-docker-workloads-to-kubernetes-kapsule/index.mdx index 67e0204c05..a75eeb11c8 100644 --- a/tutorials/migrating-docker-workloads-to-kubernetes-kapsule/index.mdx +++ b/tutorials/migrating-docker-workloads-to-kubernetes-kapsule/index.mdx @@ -12,11 +12,13 @@ dates: validation: 2025-05-19 posted: 2024-11-14 --- +import Requirements from '@macros/iam/requirements.mdx' + This step-by-step guide will help you migrate your applications packaged in Docker containers to **Scaleway Kubernetes Kapsule**, Scaleway's managed Kubernetes service. Whether you are new to Kubernetes or have some experience, this guide aims to simplify the migration process, addressing common challenges and providing clear instructions. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/migrating-from-another-managed-kubernetes-service-to-scaleway-kapsule/index.mdx b/tutorials/migrating-from-another-managed-kubernetes-service-to-scaleway-kapsule/index.mdx index acc56130f3..524a0c2f74 100644 --- a/tutorials/migrating-from-another-managed-kubernetes-service-to-scaleway-kapsule/index.mdx +++ b/tutorials/migrating-from-another-managed-kubernetes-service-to-scaleway-kapsule/index.mdx @@ -12,11 +12,13 @@ dates: validation: 2025-05-19 posted: 2024-11-13 --- +import Requirements from '@macros/iam/requirements.mdx' + This guide provides a step-by-step process to help you migrate your existing Kubernetes clusters from other managed services like GKE (Google Kubernetes Engine), EKS (Amazon Elastic Kubernetes Service), or AKS (Azure Kubernetes Service) to **[Scaleway Kapsule](/kubernetes/quickstart/)**. The migration aims to minimize downtime and ensure a smooth transition of your workloads. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/minikube-elastic-metal/index.mdx b/tutorials/minikube-elastic-metal/index.mdx index c7241f1dab..0cc8ced7a3 100644 --- a/tutorials/minikube-elastic-metal/index.mdx +++ b/tutorials/minikube-elastic-metal/index.mdx @@ -14,6 +14,8 @@ dates: posted: 2019-05-27 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes is a powerful open-source platform designed for managing containerized workloads and services, boasting a rapidly expanding ecosystem. It orchestrates computing, networking, and storage infrastructure to streamline user workloads efficiently. Originally released by Google in 2014, Kubernetes offers declarative configuration and automation capabilities, making it a preferred choice for modern software development and deployment. @@ -36,7 +38,7 @@ Minikube provides support for various essential Kubernetes features, including: - Ingress configuration for routing external traffic to Kubernetes services. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mist-streaming-server/index.mdx b/tutorials/mist-streaming-server/index.mdx index 5b03495a38..da60328700 100644 --- a/tutorials/mist-streaming-server/index.mdx +++ b/tutorials/mist-streaming-server/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-01-02 posted: 2020-07-01 --- +import Requirements from '@macros/iam/requirements.mdx' + MistServer is one of the leading OTT (internet streaming) toolkits with an open source core. It allows you to deliver your media content to your users via the internet. Mist Server supports the OBS Studio suite, making it easy to set up your own web stream. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mlx-array-framework-apple-silicon/index.mdx b/tutorials/mlx-array-framework-apple-silicon/index.mdx index 78d9e66e30..9147ae5e73 100644 --- a/tutorials/mlx-array-framework-apple-silicon/index.mdx +++ b/tutorials/mlx-array-framework-apple-silicon/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2023-12-15 --- +import Requirements from '@macros/iam/requirements.mdx' + MLX, an array framework designed for effective and versatile machine learning on Apple silicon, was developed by Apple’s machine learning research team. It was developed by machine-learning researchers focusing on catering to their peers, emphasizing a balance between user-friendliness and efficiency in model training and deployment. The framework boasts a deliberately straightforward design that facilitates seamless extension and enhancement by researchers, fostering the swift exploration of innovative ideas. @@ -28,7 +30,7 @@ Key features of MLX include: * **Multi-device Support:** MLX operations are versatile and capable of running on supported devices, currently spanning the CPU and GPU. * **Unified Memory:** A standout distinction lies in MLX's unified memory model. Arrays within MLX reside in shared memory, permitting operations on arrays across different device types without necessitating data transfers. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mongodb-ubuntu-1604/index.mdx b/tutorials/mongodb-ubuntu-1604/index.mdx index 88828d1eb2..2905e97e0c 100644 --- a/tutorials/mongodb-ubuntu-1604/index.mdx +++ b/tutorials/mongodb-ubuntu-1604/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-01-02 posted: 2018-06-25 --- +import Requirements from '@macros/iam/requirements.mdx' + MongoDB® is a document-oriented database that is free and open-source. It is considered one of the most popular NoSQL database engines because it is scalable, powerful, reliable, and easy to use. In contrast to relational databases, MongoDB® does not require a deep predefined schema before you can add data since it can be altered at any time. As it uses the NoSQL concept, data rows are stored in JSON-like documents which allows arbitrary data to be inserted. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/monitor-gpu-instance-cockpit/index.mdx b/tutorials/monitor-gpu-instance-cockpit/index.mdx index 6b623bc816..6c82cf174e 100644 --- a/tutorials/monitor-gpu-instance-cockpit/index.mdx +++ b/tutorials/monitor-gpu-instance-cockpit/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-04-30 posted: 2024-10-21 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial guides you through the process of monitoring your [GPU Instances](/instances/concepts/#gpu-instance) using Cockpit and the [NVIDIA Data Center GPU Manager (DCGM) Exporter](https://docs.nvidia.com/datacenter/cloud-native/gpu-telemetry/latest/dcgm-exporter.html). Visualize your GPU Instances' metrics and ensure optimal performance and usage of your resources. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/monitor-k8s-grafana/index.mdx b/tutorials/monitor-k8s-grafana/index.mdx index a6dd22a016..f3b0fb61c7 100644 --- a/tutorials/monitor-k8s-grafana/index.mdx +++ b/tutorials/monitor-k8s-grafana/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-02 posted: 2020-03-18 --- +import Requirements from '@macros/iam/requirements.mdx' + Kubernetes Kapsule provides a managed Kubernetes environment to create, configure, and run a cluster of preconfigured machines for containerized applications. @@ -27,7 +29,7 @@ This tutorial will explain how to monitor your [Kubernetes Kapsule](https://www. Instead of setting up everything manually as described in this tutorial, you can use [Scaleway Cockpit](https://www.scaleway.com/en/cockpit/) to monitor your Kubernetes cluster easily and without additional configuration. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx b/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx index 38191b23c9..537981d6a3 100644 --- a/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx +++ b/tutorials/mutli-node-rocket-chat-community-private-network/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-02 posted: 2020-10-19 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how the Private Network feature can help you to build a distributed [Rocket.Chat](/tutorials/run-messaging-platform-with-rocketchat/) application on [General Purpose](https://www.scaleway.com/en/cost-optimized-instances/) and [Development](https://www.scaleway.com/en/cost-optimized-instances/) Instances using a Private Network to communicate securely between them: @@ -31,7 +33,7 @@ To reach the goal of this tutorial, you will use four [Production-Optimized Inst We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/nats-rdb-offload/index.mdx b/tutorials/nats-rdb-offload/index.mdx index afa736add0..3b95de99dd 100644 --- a/tutorials/nats-rdb-offload/index.mdx +++ b/tutorials/nats-rdb-offload/index.mdx @@ -14,6 +14,8 @@ dates: validation: posted: --- +import Requirements from '@macros/iam/requirements.mdx' + ## Introduction @@ -30,7 +32,7 @@ This project exemplifies a decoupled architecture, where producer and consumer p To properly follow this tutorial, we recommend you [create a dedicated Project](/organizations-and-projects/how-to/create-a-project/) in your Scaleway account. You can name it `RDB and NATS Tutorial`. It will hold all your Scaleway resources created for this tutorial, so they will be easier to find. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/nextcloud-instantapp/index.mdx b/tutorials/nextcloud-instantapp/index.mdx index 5464fa881c..9b2bbb2c2d 100644 --- a/tutorials/nextcloud-instantapp/index.mdx +++ b/tutorials/nextcloud-instantapp/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-03-06 posted: 2018-08-16 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, we show you how to deploy your personal cloud storage with the NextCloud InstantApp in seconds. NextCloud allows you to create self-hosted cloud storage to host files, folders, contacts, photo galleries, calendars, and more on your Instance. Scaleway's NextCloud image is based on Ubuntu 22.04 LTS (Jammy Jellyfish), the NextCloud application, MariaDB as the database engine, and it uses database tuning according to [NextCloud's official recommendations](https://docs.nextcloud.com/server/27/admin_manual/configuration_database/linux_database_configuration.html#configuring-a-mysql-or-mariadb-database). By default, this image supports [routed IPs](/instances/api-cli/using-routed-ips/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/nextjs-app-serverless-functions-sqldb/index.mdx b/tutorials/nextjs-app-serverless-functions-sqldb/index.mdx index 36abd43a11..c515f12b32 100644 --- a/tutorials/nextjs-app-serverless-functions-sqldb/index.mdx +++ b/tutorials/nextjs-app-serverless-functions-sqldb/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2024-03-14 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial will guide you through deploying a fully serverless Next.js application using a Serverless Container and a Serverless SQL Database. @@ -19,7 +21,7 @@ You can either deploy your application: - [step by step using Scaleway CLI](#deploy-next.js-application-frontend-using-serverless-containers) to understand each detailed action performed, and the resources and subresources required - [using a Terraform/OpenTofu template](#deploy-a-next.js-application-using-terraform-templates) to deploy your application faster and have a ready-to-use Infrastructure as Code. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/nginx-reverse-proxy/index.mdx b/tutorials/nginx-reverse-proxy/index.mdx index 9c2d4cc1f2..60c9a87e42 100644 --- a/tutorials/nginx-reverse-proxy/index.mdx +++ b/tutorials/nginx-reverse-proxy/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-07-02 posted: 2018-10-11 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/nvidia-triton/index.mdx b/tutorials/nvidia-triton/index.mdx index 4b7dae0e71..a36d9406bb 100644 --- a/tutorials/nvidia-triton/index.mdx +++ b/tutorials/nvidia-triton/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-04-01 posted: 2023-08-23 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, we will walk you through the process of deploying machine learning models using [NVIDIA Triton Inference Server](https://developer.nvidia.com/triton-inference-server) on Scaleway Object Storage. We will cover how to set up Triton Inference Server, store your model in an Object Storage bucket, and enable metric export for monitoring. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/object-storage-s3fs/index.mdx b/tutorials/object-storage-s3fs/index.mdx index 10c0932d3c..97dcff17ac 100644 --- a/tutorials/object-storage-s3fs/index.mdx +++ b/tutorials/object-storage-s3fs/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-01-02 posted: 2018-07-16 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial you learn how to use [s3fs](https://github.com/s3fs-fuse/s3fs-fuse) as a client for [Scaleway Object Storage](/object-storage/concepts/#object-storage). `s3fs` is a FUSE-backed file interface for S3, allowing you to mount Object Storage buckets on your local Linux or macOS system. Files are preserved in their native object format, enabling compatibility with tools like AWS CLI. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/odoo-easy-deploy/index.mdx b/tutorials/odoo-easy-deploy/index.mdx index 420515e14f..fb391926f5 100644 --- a/tutorials/odoo-easy-deploy/index.mdx +++ b/tutorials/odoo-easy-deploy/index.mdx @@ -16,12 +16,14 @@ categories: - container-registry - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + Are you prepared to elevate your business operations using the capabilities of open-source technology? Look no further than Odoo! This collection of business applications, coded in Python, encompasses a wide range of functionalities, including website development, e-commerce, HR management, and accounting, all conveniently bundled into an accessible and cost-effective package. With a user base exceeding 2 million worldwide, enterprises of all scales are capitalizing on Odoo's harmonious integration and modular structure to streamline their processes and enhance their profitability. But how can you initiate your Odoo journey? Our guide will walk you through the process of setting up Odoo on a [Scaleway Kubernetes Kapsule](/kubernetes/quickstart/) using the [easy-deploy](/kubernetes/how-to/enable-easy-deploy/) feature, easily accessible right from the [Scaleway console](https://console.scaleway.com). In minimal time, you will have Odoo up and operational, primed to advance your business endeavors. Just adhere to the steps outlined in the sidebar on the right to get started. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/odoo/index.mdx b/tutorials/odoo/index.mdx index 5a89397d52..ad690958e2 100644 --- a/tutorials/odoo/index.mdx +++ b/tutorials/odoo/index.mdx @@ -15,6 +15,8 @@ dates: validation: 2025-01-02 posted: 2020-08-13 --- +import Requirements from '@macros/iam/requirements.mdx' + Odoo is a business management software, including different modules such as CRM, billing, e-commerce, warehouse, website builder, inventory management, and accounting. The software is distributed in an open-code model, providing a free Community Edition, released under the GNU [LGPLv3](https://www.gnu.org/licenses/lgpl-3.0.en.html) software license. The source code of the Community Edition is available on [the company's GitHub](https://github.com/odoo/odoo). Besides the free and open-source Community Edition, a proprietary "Enterprise" version provides additional features and services. @@ -22,7 +24,7 @@ The modular design of Odoo allows developers to create additional modules or app This tutorial will show you how to deploy Odoo 16 on a Scaleway machine running Ubuntu Noble Numbat (24.04 LTS). This could be a [Dedibox](https://www.scaleway.com/en/dedibox/), an [Instance](https://www.scaleway.com/en/virtual-instances/) or an [Elastic Metal server](https://www.scaleway.com/en/elastic-metal/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/openvpn-instant-app/index.mdx b/tutorials/openvpn-instant-app/index.mdx index d85f7a65a4..2759fba269 100644 --- a/tutorials/openvpn-instant-app/index.mdx +++ b/tutorials/openvpn-instant-app/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2015-06-11 --- +import Requirements from '@macros/iam/requirements.mdx' + OpenVPN is an open-source software application that allows you to create Virtual Private Network (VPN) connections, to securely access the internet from a remote connection. @@ -22,7 +24,7 @@ OpenVPN InstantApp comes with: - an OpenVPN server - a client configuration tool to set up your client - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/overleaf/index.mdx b/tutorials/overleaf/index.mdx index 51499feca1..94a1062005 100644 --- a/tutorials/overleaf/index.mdx +++ b/tutorials/overleaf/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-09 posted: 2023-10-02 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) - An [SSH key](/organizations-and-projects/how-to/create-ssh-key/) diff --git a/tutorials/pihole-vpn/index.mdx b/tutorials/pihole-vpn/index.mdx index ae500036f8..b75d03cf79 100644 --- a/tutorials/pihole-vpn/index.mdx +++ b/tutorials/pihole-vpn/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-02-11 posted: 2020-12-09 --- +import Requirements from '@macros/iam/requirements.mdx' + Pi-hole is a DNS sinkhole that blocks unwanted ads and trackers at the network level. When combined with a VPN, it provides a secure and ad-free internet browsing experience. @@ -21,7 +23,7 @@ This guide will show you how to: - Install either OpenVPN or WireGuard using **PiVPN** - Implement best security practices to protect your Instance - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/plausible-analytics-ubuntu/index.mdx b/tutorials/plausible-analytics-ubuntu/index.mdx index ecf3c1873a..c0b84e5d38 100644 --- a/tutorials/plausible-analytics-ubuntu/index.mdx +++ b/tutorials/plausible-analytics-ubuntu/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-06 posted: 2023-02-21 --- +import Requirements from '@macros/iam/requirements.mdx' + Plausible Analytics is an open-source web analytics initiative driven by the goal of enhancing privacy in analytics. It offers the possibility to independently host the solution on Scaleway Instances, thereby decreasing reliance on and surveillance from AdTech-related tools. @@ -21,7 +23,7 @@ This tool significantly contributes to the enhancement of site performance, with We recommend you follow this tutorial using a [Cost-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/postgis-managed-databases/index.mdx b/tutorials/postgis-managed-databases/index.mdx index 31ca3406cb..c73bf736b1 100644 --- a/tutorials/postgis-managed-databases/index.mdx +++ b/tutorials/postgis-managed-databases/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2019-12-31 --- +import Requirements from '@macros/iam/requirements.mdx' + PostGIS is an extension to the PostgreSQL database management system developed by the Canadian company Refractions Research Inc. The extension allows storing and managing Geographic Information Systems (GIS) objects in PostgreSQL. It is available on Scaleway Databases. @@ -23,7 +25,7 @@ PostGIS was published under the [GNU GPL license](https://en.wikipedia.org/wiki/ The answers to these frequently asked questions used to be provided by specialized GIS (Geographic Information Systems) applications. However, these were not a viable solution for dealing with massive spatial datasets (for example: a dataset that includes all the routes in Europe). This is where modern systems like PostGIS step in. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/postman-api/index.mdx b/tutorials/postman-api/index.mdx index ba7a61d038..1b475ae018 100644 --- a/tutorials/postman-api/index.mdx +++ b/tutorials/postman-api/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-08 posted: 2022-03-24 --- +import Requirements from '@macros/iam/requirements.mdx' + Postman is an API client that allows you to build, test, and manage APIs through a graphical interface. The platform includes features that make it easy for you to: - create, import, and test APIs @@ -24,7 +26,7 @@ Postman is an API client that allows you to build, test, and manage APIs through In this tutorial, you will learn how to import Scaleway APIs into Postman, configure your environment variables and authentication, and share your workspace with other users. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/power-on-off-instances-jobs/index.mdx b/tutorials/power-on-off-instances-jobs/index.mdx index 230fa640a8..9a52046695 100644 --- a/tutorials/power-on-off-instances-jobs/index.mdx +++ b/tutorials/power-on-off-instances-jobs/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-06-23 posted: 2025-06-09 --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of powering a [Scaleway Instance](/instances/quickstart/) on and off, on a recurring schedule using a Serverless Job. Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/tutorials/prestashop-dedibox/index.mdx b/tutorials/prestashop-dedibox/index.mdx index 9c3a5adf6a..388f322e97 100644 --- a/tutorials/prestashop-dedibox/index.mdx +++ b/tutorials/prestashop-dedibox/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-19 posted: 2020-08-07 --- +import Requirements from '@macros/iam/requirements.mdx' + PrestaShop is a popular open-source e-commerce solution used by more than 300,000 shops worldwide and available in about 60 different languages. The software is written in the PHP programming language and uses the MySQL database management system to store its data. It is published under the Open Software License (OSL). @@ -20,7 +22,7 @@ The application comes with several hundred built-in features for managing produc In this tutorial, you will learn how to install and configure PrestaShop on Ubuntu Focal Fossa 20.04 on a [Dedibox](https://www.scaleway.com/en/dedibox/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/processing-images-structured-outputs-pixtral/index.mdx b/tutorials/processing-images-structured-outputs-pixtral/index.mdx index c00fefa9bc..400c7dfe27 100644 --- a/tutorials/processing-images-structured-outputs-pixtral/index.mdx +++ b/tutorials/processing-images-structured-outputs-pixtral/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-04-22 posted: 2024-10-09 --- +import Requirements from '@macros/iam/requirements.mdx' + In today's data-driven world, the ability to extract structured information from visual content is becoming increasingly valuable across various industries. From analyzing medical images to interpreting financial charts, from processing historical documents to cataloging diverse product lines, the applications are vast and varied. @@ -21,7 +23,7 @@ In today's data-driven world, the ability to extract structured information from This tutorial will guide you through the process of using the Pixtral vision model to analyze images and automatically generate structured outputs. We'll use Python to interact with the model and structure our data, making it easy to integrate this solution into your existing workflows. While we'll use a product catalog as an example, the techniques demonstrated here can be adapted to various use cases across different industries. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - A Python environment (version 3.7 or higher) diff --git a/tutorials/prometheus-monitoring-grafana-dashboard/index.mdx b/tutorials/prometheus-monitoring-grafana-dashboard/index.mdx index 47a9a9fe52..ea60b7f310 100644 --- a/tutorials/prometheus-monitoring-grafana-dashboard/index.mdx +++ b/tutorials/prometheus-monitoring-grafana-dashboard/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-01-30 posted: 2018-06-07 --- +import Requirements from '@macros/iam/requirements.mdx' + Prometheus is a flexible monitoring solution developed since 2012. It stores all data in a time series database, offering a multi-dimensional data model and a powerful query language to generate reports of the monitored resources. In this tutorial, you will learn how to use a Prometheus Monitoring Instance with a Grafana dashboard. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/protect-server-fail2ban/index.mdx b/tutorials/protect-server-fail2ban/index.mdx index 6f0def8cc6..ca7b89def5 100644 --- a/tutorials/protect-server-fail2ban/index.mdx +++ b/tutorials/protect-server-fail2ban/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-04-08 posted: 2018-08-22 --- +import Requirements from '@macros/iam/requirements.mdx' + Fail2Ban is a useful tool that analyses server log files for recurring patterns of failures. This allows blocking IPs trying to run brute force attacks against a server. In this tutorial, you will learn how to configure the service on an Ubuntu Bionic server to protect the SSH service. Fail2Ban can be used with all services generating log files. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/protect-server-using-crowdsec/index.mdx b/tutorials/protect-server-using-crowdsec/index.mdx index 18320182ff..ffe78243a5 100644 --- a/tutorials/protect-server-using-crowdsec/index.mdx +++ b/tutorials/protect-server-using-crowdsec/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2021-10-11 --- +import Requirements from '@macros/iam/requirements.mdx' + CrowdSec is an open-source software that detects malicious behavior from various connection sources, including infrastructure, systems, and applications. Similar to Fail2Ban, CrowdSec reads logs from several sources (eg: files and streams). It then parses and extracts information such as IPs, time, and environment to match it to patterns called scenarios. @@ -23,7 +25,7 @@ Another feature enables every user of CrowdSec to share their banned IPs to a Ce In this tutorial, we will set up [CrowdSec](https://crowdsec.net/) on a Dedibox and protect the SSH connection. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/proxmox-softraid/index.mdx b/tutorials/proxmox-softraid/index.mdx index c95a56ed20..0e5e19034a 100644 --- a/tutorials/proxmox-softraid/index.mdx +++ b/tutorials/proxmox-softraid/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2020-01-22 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + ## Proxmox - Overview @@ -20,7 +22,7 @@ Proxmox Virtual Environment - or Proxmox VE is a server virtualization platform, The tool provides a REST-API as well as a graphical web interface to manage the virtual machines and is licensed under the [GNU Affero General Public License, version 3](https://www.gnu.org/licenses/agpl-3.0.de.html). - + - A Dedibox account logged into the [console](https://console.online.net) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/proxy-protocol-v2-load-balancer/index.mdx b/tutorials/proxy-protocol-v2-load-balancer/index.mdx index fca66bd974..a1ce76b367 100644 --- a/tutorials/proxy-protocol-v2-load-balancer/index.mdx +++ b/tutorials/proxy-protocol-v2-load-balancer/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2019-06-28 --- +import Requirements from '@macros/iam/requirements.mdx' + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/pushing-metrics-logs-from-scw-instance/index.mdx b/tutorials/pushing-metrics-logs-from-scw-instance/index.mdx index 8b75627292..fd03c38760 100644 --- a/tutorials/pushing-metrics-logs-from-scw-instance/index.mdx +++ b/tutorials/pushing-metrics-logs-from-scw-instance/index.mdx @@ -13,11 +13,13 @@ dates: validation: 2025-04-22 posted: 2023-06-28 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to push your metrics and logs from a [Scaleway Instance](/instances/concepts/#instance). You can also use this tutorial to **push metrics and logs from external Instances (i.e. Instances outside of Scaleway)**. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/python-for-loops/index.mdx b/tutorials/python-for-loops/index.mdx index 498774b943..d5deb7ab40 100644 --- a/tutorials/python-for-loops/index.mdx +++ b/tutorials/python-for-loops/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-22 posted: 2023-06-28 --- +import Requirements from '@macros/iam/requirements.mdx' + If you're coming to this tutorial as a complete Python beginner, make sure you are familiar with the Python concepts covered in our [Python for complete beginners](/tutorials/get-started-python/) tutorial, and with [dictionaries and lists](/tutorials/python-lists-dicts/). @@ -68,7 +70,7 @@ There are two types of loops in Python: This tutorial concerns only **for** loops. - + - [Installed Python](/tutorials/get-started-python/#1-installing-python) on your machine - Knowledge of how to execute Python commands and see their output, using for example either the [Python Interactive Shell](/tutorials/get-started-python/#2-getting-ready-to-code-opening-the-python-interactive-shell), a [text editor and the terminal](/tutorials/get-started-python/#6-from-the-shell-to-a-script), or another method such as Jupyter notebook diff --git a/tutorials/python-lists-dicts/index.mdx b/tutorials/python-lists-dicts/index.mdx index cea640e372..495488b114 100644 --- a/tutorials/python-lists-dicts/index.mdx +++ b/tutorials/python-lists-dicts/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2023-03-23 --- +import Requirements from '@macros/iam/requirements.mdx' + If you're coming to this tutorial as a complete Python beginner, make sure you're familiar with the Python concepts covered in our [Python for complete beginners](/tutorials/get-started-python/) tutorial first. You might also be interested in the next tutorial in the series: [Getting started with Python for-loops](/tutorials/python-for-loops/). @@ -41,7 +43,7 @@ The examples in this tutorial use short, manually-created lists and dictionaries Read on to find out more about lists and dictionaries, and learn how to create and manipulate them in Python, with lots of examples provided. - + - [Installed Python](/tutorials/get-started-python/#1-installing-python) on your machine - Knowledge of how to execute Python commands and see their output, using for example either the [Python Interactive Shell](/tutorials/get-started-python/#2-getting-ready-to-code-opening-the-python-interactive-shell), a [text editor and the terminal](/tutorials/get-started-python/#6-from-the-shell-to-a-script) or another method such as Jupyter notebook diff --git a/tutorials/remote-desktop-with-xrdp/index.mdx b/tutorials/remote-desktop-with-xrdp/index.mdx index 7b6762e1c5..d9c7a7cab7 100644 --- a/tutorials/remote-desktop-with-xrdp/index.mdx +++ b/tutorials/remote-desktop-with-xrdp/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-22 posted: 2019-12-02 --- +import Requirements from '@macros/iam/requirements.mdx' + ## xRDP - Overview @@ -23,7 +25,7 @@ RDP connections are encrypted by default using TLS for increased security. In this tutorial, you will learn how to install the [xRDP](http://xrdp.org/) server together with [xfce](https://xfce.org/), a lightweight and stable desktop environment ideally suited for the use of a remote desktop. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/restic-s3-backup/index.mdx b/tutorials/restic-s3-backup/index.mdx index ad302ef25d..c34d5b9f1d 100644 --- a/tutorials/restic-s3-backup/index.mdx +++ b/tutorials/restic-s3-backup/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-06-19 posted: 2022-04-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Restic is a backup tool that allows you to back up your Linux, Windows, Mac, or BSD machines and send your backups to repositories via [different storage protocols](https://restic.readthedocs.io/en/stable/030_preparing_a_new_repo.html), including Object Storage. In this tutorial, you learn how to backup a Scaleway Instance running on Ubuntu 20.04 using Restic and Object Storage. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/rtmp-self-hosted-streaming/index.mdx b/tutorials/rtmp-self-hosted-streaming/index.mdx index 55b3636cb9..4270b9df37 100644 --- a/tutorials/rtmp-self-hosted-streaming/index.mdx +++ b/tutorials/rtmp-self-hosted-streaming/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2019-05-20 --- +import Requirements from '@macros/iam/requirements.mdx' + The Internet's fascination with live video streaming continues to soar, with platforms such as Twitch and YouTube providing easy access to engage with live and recorded content. @@ -25,7 +27,7 @@ Using the open-source [RTMP protocol](https://en.wikipedia.org/wiki/Real-Time_Me We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/ruby-on-rails/index.mdx b/tutorials/ruby-on-rails/index.mdx index 85c3cea68a..f2067bab0d 100644 --- a/tutorials/ruby-on-rails/index.mdx +++ b/tutorials/ruby-on-rails/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-01-22 posted: 2020-01-20 --- +import Requirements from '@macros/iam/requirements.mdx' + [Ruby on Rails](https://rubyonrails.org/) is a server-side web application framework written in Ruby and released under the MIT License. @@ -30,7 +32,7 @@ In this tutorial, you will learn basic steps to configure a deployment-ready mac - [Capistrano](https://capistranorb.com/) as deployment utility - [Ubuntu 22.04](https://www.ubuntu.com/) as operating system and [Systemd](https://www.freedesktop.org/wiki/Software/systemd/) for keeping processes up. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/run-manage-linux-vm-on-apple-silicon-tart/index.mdx b/tutorials/run-manage-linux-vm-on-apple-silicon-tart/index.mdx index 5e5ac45aaa..e093e9c447 100644 --- a/tutorials/run-manage-linux-vm-on-apple-silicon-tart/index.mdx +++ b/tutorials/run-manage-linux-vm-on-apple-silicon-tart/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-02-11 posted: 2024-01-30 --- +import Requirements from '@macros/iam/requirements.mdx' + Tart is a virtualization toolset developed for building, running, and managing macOS and Linux virtual machines (VMs) on Apple silicon. Engineered by CI experts to meet automation needs, Tart provides several noteworthy features. @@ -25,7 +27,7 @@ One notable application of Tart is its role as the driving force behind the Cirr This service not only offers 2-3 times better performance but also does so at a fraction of the cost, highlighting Tart's ability to optimize virtualization for enhanced efficiency. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/run-messaging-platform-with-rocketchat/index.mdx b/tutorials/run-messaging-platform-with-rocketchat/index.mdx index 894c85c84e..eedfefd99e 100644 --- a/tutorials/run-messaging-platform-with-rocketchat/index.mdx +++ b/tutorials/run-messaging-platform-with-rocketchat/index.mdx @@ -14,10 +14,12 @@ dates: posted: 2019-01-30 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + [Rocket.Chat](https://rocket.chat) is a free and open-source team chat software solution. It provides features like audio and video conferencing, guest access, screen sharing, file sharing, LiveChat, LDAP Group Sync, two-factor authentication (2FA), E2E encryption, SSO, and more. The tool uses [MongoDB](/tutorials/mongodb-ubuntu-1604/) as a database and the JavaScript runtime [Node.js](https://nodejs.org/en/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/run-nodejs-express-server-on-serverless-containers/index.mdx b/tutorials/run-nodejs-express-server-on-serverless-containers/index.mdx index d69efe6416..e31d60d43f 100644 --- a/tutorials/run-nodejs-express-server-on-serverless-containers/index.mdx +++ b/tutorials/run-nodejs-express-server-on-serverless-containers/index.mdx @@ -13,12 +13,14 @@ dates: posted: 2021-10-14 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Express is a lightweight Node.js framework designed to ease building applications and APIs. In this tutorial you will learn how to configure your [Express.js](http://expressjs.com/) application to run on Scaleway Serverless Container. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/run-python-flask-server-on-serverless-container/index.mdx b/tutorials/run-python-flask-server-on-serverless-container/index.mdx index 1dc20dd4a4..af0fea48a7 100644 --- a/tutorials/run-python-flask-server-on-serverless-container/index.mdx +++ b/tutorials/run-python-flask-server-on-serverless-container/index.mdx @@ -13,10 +13,12 @@ dates: posted: 2021-10-14 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Flask is a Python framework that enables you to easily deploy simple web servers and APIs. In this tutorial, you will learn how to configure your Flask application to run on a Serverless Container. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/s3-customize-url-cname/index.mdx b/tutorials/s3-customize-url-cname/index.mdx index 4741cf8919..8a5c1eee11 100644 --- a/tutorials/s3-customize-url-cname/index.mdx +++ b/tutorials/s3-customize-url-cname/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-01-22 posted: 2019-05-21 --- +import Requirements from '@macros/iam/requirements.mdx' + If you are using Scaleway Object Storage, you might not want the `scw.cloud` domain name to appear in your bucket's URL. This may be the case if, for example, you are providing files to download or hosting the images of your website from a bucket. You may prefer a domain name such as `download.mywebsite.com` to display on your links, instead of `download.mywebsite.com.s3.fr-par.scw.cloud`. In this tutorial, we show you how to use CNAME to map a domain or subdomain to an Object Storage bucket and access the files stored in the bucket via your own domain name. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/s3cmd/index.mdx b/tutorials/s3cmd/index.mdx index e1c91171e2..e6a40db4c2 100644 --- a/tutorials/s3cmd/index.mdx +++ b/tutorials/s3cmd/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-01-02 posted: 2018-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to use [s3cmd](https://github.com/s3tools/s3cmd) as a client for [Scaleway Object Storage](/object-storage/concepts/#object-storage). `s3cmd` is a tool that allows you to create, list and delete buckets from the command line, as well as to download, upload, and delete objects to/from your buckets. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/self-hosted-repository-gitea/index.mdx b/tutorials/self-hosted-repository-gitea/index.mdx index efafd8247f..00a9a1c6b2 100644 --- a/tutorials/self-hosted-repository-gitea/index.mdx +++ b/tutorials/self-hosted-repository-gitea/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-06 posted: 2019-05-28 --- +import Requirements from '@macros/iam/requirements.mdx' + Gitea is a Git service that can be self-hosted to provide a lightweight code hosting solution. Written in Go and licensed under the MIT license, it is a community-managed fork of Gogs. @@ -21,7 +23,7 @@ Unlike many other client-server systems, Git allows every Git directory on every While Git was initially developed for software development purposes, it can track changes in any file. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/sem-terraform/index.mdx b/tutorials/sem-terraform/index.mdx index a1334ece4c..7de37c29e9 100644 --- a/tutorials/sem-terraform/index.mdx +++ b/tutorials/sem-terraform/index.mdx @@ -14,10 +14,12 @@ dates: validation: 2025-06-19 posted: 2024-06-03 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will use a Terraform/OpenTofu configuration file that builds your entire infrastructure, such as a [Database Instance](/managed-databases-for-postgresql-and-mysql/concepts/#database-instance), a [secret](/secret-manager/concepts/#secret), and a [version](/secret-manager/concepts/#version) in which your database credentials are stored. You will then be able to access your database credentials securely from the Scaleway console. - + - A Scaleway account logged into the [console](https://console.scaleway.com/) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/send-emails-tem-serverless-framework/index.mdx b/tutorials/send-emails-tem-serverless-framework/index.mdx index 901c73e3fa..d0dc2dea00 100644 --- a/tutorials/send-emails-tem-serverless-framework/index.mdx +++ b/tutorials/send-emails-tem-serverless-framework/index.mdx @@ -15,10 +15,12 @@ dates: validation: 2025-02-18 posted: 2024-02-01 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to send emails with [Transactional Email](/transactional-email/quickstart/) and [Serverless Functions](/serverless-functions/quickstart/) using the [Serverless Framework tool](/serverless-functions/reference-content/deploy-function/#serverless-framework). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/send-emails-with-serverless-and-tem/index.mdx b/tutorials/send-emails-with-serverless-and-tem/index.mdx index ae39e36bf0..c43eb9f208 100644 --- a/tutorials/send-emails-with-serverless-and-tem/index.mdx +++ b/tutorials/send-emails-with-serverless-and-tem/index.mdx @@ -15,10 +15,12 @@ dates: validation: 2025-02-11 posted: 2023-04-27 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to send emails with [Transactional Email](/transactional-email/quickstart/) and [Serverless Functions](/serverless-functions/quickstart/) using a Terraform/OpenTofu configuration file that builds your entire infrastructure, such as a Serverless Function and a website with a registration page hosted on an Object Storage bucket. It also allows you to configure SPF, DKIM, and MX records on your sending domain. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/send-sms-iot-device-twilio/index.mdx b/tutorials/send-sms-iot-device-twilio/index.mdx index 780f38d461..bc96ef6315 100644 --- a/tutorials/send-sms-iot-device-twilio/index.mdx +++ b/tutorials/send-sms-iot-device-twilio/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2020-10-13 --- +import Requirements from '@macros/iam/requirements.mdx' + SMS messages are the universal way to quickly send information to someone, with high reachability, quick delivery, and a high rate of opening. Today, we are going to take a look at how to send SMS messages right from your IoT Hub. @@ -31,7 +33,7 @@ We are going to do things in reverse order: - Set up an IoT Hub and configure a Route to the Function - Give it a try - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/sentry-error-tracking/index.mdx b/tutorials/sentry-error-tracking/index.mdx index b5141862d2..55f39d8e4b 100644 --- a/tutorials/sentry-error-tracking/index.mdx +++ b/tutorials/sentry-error-tracking/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-03-27 posted: 2018-06-07 --- +import Requirements from '@macros/iam/requirements.mdx' + In the rapidly evolving landscape of today's world, applications serve as the backbone of numerous industries. Whether it is engineers, support technicians, or product managers, maintaining vigilance over an application's performance is essential for ensuring uninterrupted functionality. @@ -30,7 +32,7 @@ You can find all reports on a dashboard, which makes it easy to triage the probl This tutorial details how to set up a [Sentry](https://sentry.io/welcome/) self-hosted server on a Scaleway Instance to start error tracking in your applications. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/set-up-spf-dkim-for-dns-providers/index.mdx b/tutorials/set-up-spf-dkim-for-dns-providers/index.mdx index 1bec57cae4..5ab514810c 100644 --- a/tutorials/set-up-spf-dkim-for-dns-providers/index.mdx +++ b/tutorials/set-up-spf-dkim-for-dns-providers/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-01-06 posted: 2022-11-07 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to set up [SPF](/transactional-email/concepts/#spf-record) and [DKIM](/transactional-email/concepts/#dkim-record) records with Transactional Email for other DNS providers such as [GoDaddy](https://www.godaddy.com/), [Cloudflare](https://www.cloudflare.com/) and [Namecheap](https://www.namecheap.com/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/set-up-yunohost-debian/index.mdx b/tutorials/set-up-yunohost-debian/index.mdx index cf27ba5a52..f89e68a1a1 100644 --- a/tutorials/set-up-yunohost-debian/index.mdx +++ b/tutorials/set-up-yunohost-debian/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-04-08 posted: 2019-02-27 --- +import Requirements from '@macros/iam/requirements.mdx' + Yunohost is an open-source solution designed for the administration of a personal server. It helps manage users, domains, and websites and comes with a full email stack. The tool is designed to be lightweight and intuitive and is designed to work with Debian 9 (Stretch). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setting-up-tunnel/index.mdx b/tutorials/setting-up-tunnel/index.mdx index d9ca47d103..4972fbf6cd 100644 --- a/tutorials/setting-up-tunnel/index.mdx +++ b/tutorials/setting-up-tunnel/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-08 posted: 2019-08-22 --- +import Requirements from '@macros/iam/requirements.mdx' + A GRE tunnel allows you to connect [Scaleway Instances](https://www.scaleway.com/en/virtual-instances/) with [Scaleway Dedibox dedicated servers](https://www.scaleway.com/en/dedibox/) and vice versa to exchange files over a virtual network connection that passes through the public internet. @@ -20,7 +22,7 @@ A GRE tunnel allows you to connect [Scaleway Instances](https://www.scaleway.com The [Generic Routing Encapsulation (GRE)](https://en.wikipedia.org/wiki/Generic_Routing_Encapsulation) protocol is designed as a tunneling tool to carry any [OSI Layer 3 protocol](https://en.wikipedia.org/wiki/Network_layer) over an IP network. It creates a point-to-point connection like a virtual Private Network (VPN) but without adding lots of latency or overhead. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-ampere-ai-framework-arm-instances/index.mdx b/tutorials/setup-ampere-ai-framework-arm-instances/index.mdx index 41407498f8..34b1b1bdc8 100644 --- a/tutorials/setup-ampere-ai-framework-arm-instances/index.mdx +++ b/tutorials/setup-ampere-ai-framework-arm-instances/index.mdx @@ -13,6 +13,8 @@ dates: posted: 2024-02-09 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Ampere AI frameworks provide a comprehensive set of tools and libraries for building and deploying AI models on ARM-based Instances. @@ -20,7 +22,7 @@ With the increasing popularity of ARM architecture in data centers and cloud env In this tutorial, we will walk through the process of setting up and using Ampere-optimized AI frameworks on [Scaleway COP-ARM Instances](https://www.scaleway.com/en/cost-optimized-instances-based-on-arm/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-elastic-metal-proxmox-cluster-with-private-networks/index.mdx b/tutorials/setup-elastic-metal-proxmox-cluster-with-private-networks/index.mdx index ab42433313..8404b2d020 100644 --- a/tutorials/setup-elastic-metal-proxmox-cluster-with-private-networks/index.mdx +++ b/tutorials/setup-elastic-metal-proxmox-cluster-with-private-networks/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-05-12 posted: 2022-01-10 --- +import Requirements from '@macros/iam/requirements.mdx' + Proxmox Virtual Environment (Proxmox VE) is a server virtualization platform, based on Debian Linux. It allows the deployment and management of [KVM-based](https://www.linux-kvm.org/page/Main_Page) virtual machines or [LXC](https://linuxcontainers.org/) containers. The tool provides a REST API as well as a graphical web interface to manage the virtual machines. It is also licensed under the [GNU Affero General Public License, version 3](https://www.gnu.org/licenses/agpl-3.0.html). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-jupyter-notebook/index.mdx b/tutorials/setup-jupyter-notebook/index.mdx index 0ac2b1ba39..5447795e86 100644 --- a/tutorials/setup-jupyter-notebook/index.mdx +++ b/tutorials/setup-jupyter-notebook/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-03-27 posted: 2019-07-19 --- +import Requirements from '@macros/iam/requirements.mdx' + Jupyter Notebook is a dynamic client-server application tailored for editing and executing notebook documents right from your web browser. @@ -23,7 +25,7 @@ Originally designed to cater to the needs of data science, the name **Jupyter** This evolutionary journey has seen Jupyter expand its horizons to provide support for over 40 programming languages. As an open-source project, it builds upon the foundation laid by the *IPython Notebook* project, fostering a vibrant ecosystem of innovation and collaboration. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-k8s-cluster-rancher/index.mdx b/tutorials/setup-k8s-cluster-rancher/index.mdx index bb29d77bf6..39bd8b87bb 100644 --- a/tutorials/setup-k8s-cluster-rancher/index.mdx +++ b/tutorials/setup-k8s-cluster-rancher/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-03-06 posted: 2019-08-12 --- +import Requirements from '@macros/iam/requirements.mdx' + Rancher is an open-source container management platform providing a graphical interface that makes container management easier. The Rancher UI makes it easy to manage secrets, roles, and permissions. It allows you to scale nodes and pods and set up load balancers without requiring a command-line tool or editing hard-to-read YAML files. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-lamp-stack-ubuntu2204/index.mdx b/tutorials/setup-lamp-stack-ubuntu2204/index.mdx index 6c6e7ee583..74ed486b1b 100644 --- a/tutorials/setup-lamp-stack-ubuntu2204/index.mdx +++ b/tutorials/setup-lamp-stack-ubuntu2204/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-04-22 posted: 2022-04-28 --- +import Requirements from '@macros/iam/requirements.mdx' + The LAMP stack references a group of software that can be used to serve dynamic web applications and websites. LAMP is an acronym and stands for **L**inux, **A**pache, **M**ySQL, and **P**HP. The concept describes a server environment that consists of a Linux operating system (Ubuntu Jammy Jellyfish 22.04 LTS), an Apache web server, a MySQL (or MariaDB) database server, and the PHP programming language. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-minecraft/index.mdx b/tutorials/setup-minecraft/index.mdx index 47f37a2d8c..bb51bb5573 100644 --- a/tutorials/setup-minecraft/index.mdx +++ b/tutorials/setup-minecraft/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2019-11-15 --- +import Requirements from '@macros/iam/requirements.mdx' + In 2011, the gaming world changed forever with the release of Minecraft. @@ -43,7 +45,7 @@ The Minecraft server is a Java application and runs perfectly on [Scaleway Insta ## How can I create my own Minecraft server maker? - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-mongodb-on-ubuntu/index.mdx b/tutorials/setup-mongodb-on-ubuntu/index.mdx index 842da716ed..f51423c75c 100644 --- a/tutorials/setup-mongodb-on-ubuntu/index.mdx +++ b/tutorials/setup-mongodb-on-ubuntu/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-27 posted: 2022-03-01 --- +import Requirements from '@macros/iam/requirements.mdx' + [MongoDB](https://www.mongodb.com/) is a document-oriented database, available for free as an open-source solution. Renowned for its scalability, robustness, reliability, and user-friendly nature, it is one of the premier choices among NoSQL database engines. @@ -23,7 +25,7 @@ Powerful [Production-Optimized Instance](/instances/reference-content/choosing-i We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-moodle/index.mdx b/tutorials/setup-moodle/index.mdx index 0ed592c4b1..4006457897 100644 --- a/tutorials/setup-moodle/index.mdx +++ b/tutorials/setup-moodle/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-04-22 posted: 2020-06-16 --- +import Requirements from '@macros/iam/requirements.mdx' + Moodle is an open-source **L**earning **M**anagement **S**ystem (LMS) that provides educators and students with a platform and various tools to create and participate in collaborative online learning environments. This tutorial shows you how to create your own learning platform by installing Moodle on an Instance using a LEMP-Stack (Ubuntu Linux, Nginx, MariaDB, and PHP). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-mysql/index.mdx b/tutorials/setup-mysql/index.mdx index 3156714b18..7f32208145 100644 --- a/tutorials/setup-mysql/index.mdx +++ b/tutorials/setup-mysql/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-08 posted: 2020-06-22 --- +import Requirements from '@macros/iam/requirements.mdx' + MySQL is a reliable and mature open-source relational database management system, and its first release dates back to 1995. It has been in constant development since then and is one of the most used database management systems. MySQL exists in different editions, a free and open-source [community edition](https://dev.mysql.com/downloads/), as well as several commercial licenses offering additional features. The software was initially developed by the company "MySQL AB" and is currently owned and developed by Oracle. The source code of the MySQL server is publicly available on [GitHub](https://github.com/mysql/mysql-server). @@ -21,7 +23,7 @@ MySQL is also part of the LAMP software stack, an acronym for Linux, Apache (web Ready-to-use binary packages of MySQL are available for various operating systems, from macOS X, and Windows to most Linux distributions. This tutorial will teach you how to install MySQL on Ubuntu Focal Fossa (20.04 LTS). For installation instructions on other platforms, refer to the [official installation guide](https://dev.mysql.com/doc/mysql-installation-excerpt/8.0/en/) provided by MySQL. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-nginx-reverse-proxy-s3/index.mdx b/tutorials/setup-nginx-reverse-proxy-s3/index.mdx index a3757a74d6..11b6212adb 100644 --- a/tutorials/setup-nginx-reverse-proxy-s3/index.mdx +++ b/tutorials/setup-nginx-reverse-proxy-s3/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-22 posted: 2020-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-nomad-cluster/index.mdx b/tutorials/setup-nomad-cluster/index.mdx index fdc875736d..9ce3735aed 100644 --- a/tutorials/setup-nomad-cluster/index.mdx +++ b/tutorials/setup-nomad-cluster/index.mdx @@ -14,8 +14,10 @@ dates: validation: 2025-04-22 posted: 2023-03-23 --- +import Requirements from '@macros/iam/requirements.mdx' - + + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/setup-postfix-ubuntu-bionic/index.mdx b/tutorials/setup-postfix-ubuntu-bionic/index.mdx index 60e2761aba..64a3217073 100644 --- a/tutorials/setup-postfix-ubuntu-bionic/index.mdx +++ b/tutorials/setup-postfix-ubuntu-bionic/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-07 posted: 2020-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial you will learn how to configure a mail server that uses Postfix, Dovecot, Rspamd, DKIM, and MariaDB to deliver mails securely. You learn also how to install a Roundcube webmail interface to be able to read your emails directly from your browser. @@ -20,7 +22,7 @@ You learn also how to install a Roundcube webmail interface to be able to read y We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/silence-grafana-alerts/index.mdx b/tutorials/silence-grafana-alerts/index.mdx index 7bc1d20a21..613669e2fb 100644 --- a/tutorials/silence-grafana-alerts/index.mdx +++ b/tutorials/silence-grafana-alerts/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-06-16 posted: 2025-06-16 --- +import Requirements from '@macros/iam/requirements.mdx' + This page shows you how to temporarily mute (silence) alerts without disabling them from Grafana. A silence temporarily mutes alerts that match a specific set of labels. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/sinatra/index.mdx b/tutorials/sinatra/index.mdx index 1f38375cee..d83df41590 100644 --- a/tutorials/sinatra/index.mdx +++ b/tutorials/sinatra/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-14 posted: 2018-08-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Sinatra is a lightweight domain-specific programming language and web application library that is used for writing web applications. @@ -21,7 +23,7 @@ Sinatra routes browser requests to code that can handle those requests. Then it To use Sinatra, we need to install three pieces of software: Ruby, RubyGems, and Sinatra. Sinatra depends on Ruby and RubyGems. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/snapshot-instances-jobs/index.mdx b/tutorials/snapshot-instances-jobs/index.mdx index 068499c8bf..8135dd25c7 100644 --- a/tutorials/snapshot-instances-jobs/index.mdx +++ b/tutorials/snapshot-instances-jobs/index.mdx @@ -13,11 +13,13 @@ dates: validation: 2025-03-12 posted: 2024-06-19 --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of creating snapshots of a [Scaleway Instance](/instances/quickstart/) on a recurring schedule using a Serverless Job. Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/tutorials/snapshot-managed-databases/index.mdx b/tutorials/snapshot-managed-databases/index.mdx index 2c50233dec..4fee50e668 100644 --- a/tutorials/snapshot-managed-databases/index.mdx +++ b/tutorials/snapshot-managed-databases/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-06-12 posted: 2024-06-19 --- +import Requirements from '@macros/iam/requirements.mdx' + [Scaleway Serverless Jobs](/serverless-jobs/quickstart/) allows you to create and automate recurring tasks. This tutorial will guide you through the process of creating backups and snapshots of a [Managed Database](/managed-databases-for-postgresql-and-mysql/quickstart/) on a recurring schedule using a serverless job. Serverless Jobs are perfectly adapted for these autonomous tasks, as we do not need autoscaling or exposure via a web server. Refer to the [documentation on differences between jobs, containers, and functions](/serverless-jobs/reference-content/difference-jobs-functions-containers/) for more information. - + - A Scaleway account logged into the [console](https://console.scaleway.com). - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization. diff --git a/tutorials/sns-instances-notification-system/index.mdx b/tutorials/sns-instances-notification-system/index.mdx index 61fc0da9a6..727b568665 100644 --- a/tutorials/sns-instances-notification-system/index.mdx +++ b/tutorials/sns-instances-notification-system/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-30 posted: 2024-03-08 --- +import Requirements from '@macros/iam/requirements.mdx' + ## Introduction @@ -28,7 +30,7 @@ We focus on setting up SNS with maximum automation, therefore all the infrastruc To simplify this process, the web applications for each Instance are downloaded through a Docker image. You can find the code for the publisher and the subscriber servers on [GitHub](https://github.com/scaleway/serverless-examples/tree/main/mnq/sns-instances-notification-system). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Set up authentication for the Terraform/OpenTofu provider](https://registry.terraform.io/providers/scaleway/scaleway/latest/docs#authentication) diff --git a/tutorials/socket-io/index.mdx b/tutorials/socket-io/index.mdx index 06ce6d5b62..60b3d070c5 100644 --- a/tutorials/socket-io/index.mdx +++ b/tutorials/socket-io/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-04-22 posted: 2018-07-05 --- +import Requirements from '@macros/iam/requirements.mdx' + Socket.io enables real-time event-based communication between one or more clients and a server. It works on every platform, browser, or device and is fast and reliable. Socket.io has two parts: a client-side library that runs in the browser, and a server-side library for Node.js. Both components have an identical API. Learn how to install and use Socket.io with Express using the `npm` package manager, and create a simple chat server to see the basics of how a client and server work together. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/store-s3-cyberduck/index.mdx b/tutorials/store-s3-cyberduck/index.mdx index 2f1bc0950c..f982e2d62a 100644 --- a/tutorials/store-s3-cyberduck/index.mdx +++ b/tutorials/store-s3-cyberduck/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-19 posted: 2018-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Object Storage offers a versatile solution for storing a wide array of objects, including documents, images, videos, and more, with the convenience of retrieval from any location. @@ -20,7 +22,7 @@ For example, images stored in Object Storage become readily accessible via HTTP Manage your storage through the intuitive control panel, while also benefiting from various tools designed to streamline interactions with Object Storage. Among these tools, Cyberduck stands out as a reliable and efficient option for seamless integration and management of your stored objects. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/store-s3-transmit/index.mdx b/tutorials/store-s3-transmit/index.mdx index c8df34a99a..351c53fdeb 100644 --- a/tutorials/store-s3-transmit/index.mdx +++ b/tutorials/store-s3-transmit/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-19 posted: 2018-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + Scaleway Object Storage provides a scalable and accessible solution for storing and retrieving various types of objects, including documents, images, videos, and more, from anywhere in the world. @@ -19,7 +21,7 @@ With Scaleway Object Storage, you can easily store and serve files, such as imag Additionally, you can manage your storage using the intuitive control panel or use a range of available tools to interact with your Object Storage buckets, streamlining your workflow and enhancing productivity. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/store-wp-mediacloud-s3/index.mdx b/tutorials/store-wp-mediacloud-s3/index.mdx index eb135460cf..f3ac495728 100644 --- a/tutorials/store-wp-mediacloud-s3/index.mdx +++ b/tutorials/store-wp-mediacloud-s3/index.mdx @@ -13,10 +13,12 @@ dates: validation: 2025-05-19 posted: 2019-02-13 --- +import Requirements from '@macros/iam/requirements.mdx' + Media Cloud is a WordPress plugin that allows you to automatically import the media gallery of your blog to Object Storage and upload new media files via the WordPress Media Manager directly into an Object Storage Bucket. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/strapi-app-serverless-containers-sqldb/index.mdx b/tutorials/strapi-app-serverless-containers-sqldb/index.mdx index 4a7e1ffc7d..1c6dc5e390 100644 --- a/tutorials/strapi-app-serverless-containers-sqldb/index.mdx +++ b/tutorials/strapi-app-serverless-containers-sqldb/index.mdx @@ -12,6 +12,8 @@ categories: dates: posted: 2024-05-21 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial will guide you through deploying a fully serverless Strapi headless CMS using a Serverless Container and a Serverless SQL Database. @@ -19,7 +21,7 @@ You can either deploy your application: - [step by step using the Scaleway CLI](#deploy-a-strapi-headless-cms-using-the-scaleway-cli) to understand each action performed in detail and the resources required - [using a Terraform/OpenTofu template](#deploy-strapi-using-scaleway-terraformopentofu-templates) to deploy your application faster and have ready-to-use Infrastructure as Code. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/strapi/index.mdx b/tutorials/strapi/index.mdx index d0643e7ba3..68e2d2868c 100644 --- a/tutorials/strapi/index.mdx +++ b/tutorials/strapi/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-02 posted: 2020-11-30 --- +import Requirements from '@macros/iam/requirements.mdx' + Strapi is an open-source, Node.js-based, headless CMS to manage content and make it available through a fully customizable API. Unlike traditional CMSs such as WordPress, with Strapi the content is decoupled from the front end. Strapi simultaneously provides for **content creators**, who get an easy-to-use, database-driven interface to create, organize, and manage content, and **developers**, who get the convenience of an API that they can use to query, deliver, and integrate that content to diverse applications and front ends. In this tutorial, you will learn how to deploy Strapi on a [Scaleway Instance](/instances/how-to/create-an-instance/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/systemd-essentials/index.mdx b/tutorials/systemd-essentials/index.mdx index f0a31bc62c..c84b8a24c4 100644 --- a/tutorials/systemd-essentials/index.mdx +++ b/tutorials/systemd-essentials/index.mdx @@ -12,13 +12,15 @@ dates: validation: 2025-05-19 posted: 2018-07-10 --- +import Requirements from '@macros/iam/requirements.mdx' + `systemd` is a suite of tools that provides a fast and flexible init model for managing an entire machine from boot onwards. It provides a system and service manager that runs as PID 1 and controls the start of the rest of the system. In recent years the majority of Linux distributions have adopted `systemd` as their default init system. In this tutorial, you will learn a quick overview of the most important commands you will need to know for managing a `systemd` enabled server. These should work on any operating system that uses `systemd`. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/terraform-quickstart/index.mdx b/tutorials/terraform-quickstart/index.mdx index 19d3aed070..1f8c435645 100644 --- a/tutorials/terraform-quickstart/index.mdx +++ b/tutorials/terraform-quickstart/index.mdx @@ -14,10 +14,12 @@ hero: assets/scaleway_terraform.webp dates: validation: 2025-05-19 --- +import Requirements from '@macros/iam/requirements.mdx' + HashiCorp [Terraform](http://terraform.io) or [OpenTofu](https://opentofu.org/) (open source fork of Terraform) are open-source software tools to deploy **IaaC**: Infrastructure as Code. It means that you can automate infrastructure resources such as Network, Instances, Elastic Metal servers, and more. It allows you to use declarative configuration files to manage the full lifecycle — create new resources, manage existing ones, and delete those no longer needed. The configuration language used by Terraform/OpenTofu is called [Hashicorp Configuration Language (HCL)](https://github.com/hashicorp/hcl). - + - A Scaleway account logged into the Scaleway [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/traefik-v2-cert-manager/index.mdx b/tutorials/traefik-v2-cert-manager/index.mdx index 200bc2d034..fd10f23f57 100644 --- a/tutorials/traefik-v2-cert-manager/index.mdx +++ b/tutorials/traefik-v2-cert-manager/index.mdx @@ -15,6 +15,8 @@ dates: validation: 2025-01-30 posted: 2020-07-01 --- +import Requirements from '@macros/iam/requirements.mdx' + Traefik (pronounced traffic) is a modern HTTP reverse proxy and Load Balancer designed to make the deployment of microservices easy. Traefik integrates with any HTTP and TCP-based applications and every major cluster technology. Our goal in this tutorial is to: @@ -24,7 +26,7 @@ Our goal in this tutorial is to: - Expose this test application through an ingress object, using [Traefik 2](https://doc.traefik.io/traefik/v2.2/) (deployed by Kapsule) - Expose this application securely (with `https` and [Let's Encrypt](https://letsencrypt.org/), using [cert-manager](https://github.com/jetstack/cert-manager/)) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/transform-bucket-images-triggers-functions-deploy/index.mdx b/tutorials/transform-bucket-images-triggers-functions-deploy/index.mdx index f7401da29a..d478f368d4 100644 --- a/tutorials/transform-bucket-images-triggers-functions-deploy/index.mdx +++ b/tutorials/transform-bucket-images-triggers-functions-deploy/index.mdx @@ -14,12 +14,14 @@ dates: validation: 2025-05-19 posted: 2023-07-07 --- +import Requirements from '@macros/iam/requirements.mdx' + ## Introduction In the [previous tutorial](/tutorials/transform-bucket-images-triggers-functions-set-up/), you learned how to set up your environment to use Serverless Functions with triggers to resize images from a bucket and push them to another one. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A Scaleway [Project](/organizations-and-projects/concepts/#project) dedicated to this tutorial diff --git a/tutorials/transform-bucket-images-triggers-functions-set-up/index.mdx b/tutorials/transform-bucket-images-triggers-functions-set-up/index.mdx index 8d24aaae8b..e58e1b5e8e 100644 --- a/tutorials/transform-bucket-images-triggers-functions-set-up/index.mdx +++ b/tutorials/transform-bucket-images-triggers-functions-set-up/index.mdx @@ -15,6 +15,8 @@ dates: posted: 2023-07-07 validation_frequency: 24 --- +import Requirements from '@macros/iam/requirements.mdx' + Serverless Functions are an asynchronous microservices architecture where event sources are separated from event consumers. @@ -28,7 +30,7 @@ In this tutorial, you will create the following resources to use your functions: - A queue to manage events - IAM credentials to secure your environment - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Installed [Node.js](https://nodejs.org/en/download) and [npm](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) diff --git a/tutorials/upgrade-managed-postgresql-database/index.mdx b/tutorials/upgrade-managed-postgresql-database/index.mdx index 5534d5c707..34acb8fc88 100644 --- a/tutorials/upgrade-managed-postgresql-database/index.mdx +++ b/tutorials/upgrade-managed-postgresql-database/index.mdx @@ -11,6 +11,8 @@ dates: categories: - postgresql-and-mysql --- +import Requirements from '@macros/iam/requirements.mdx' + [PostgreSQL](https://www.postgresql.org/) is a powerful, open-source object-relational database system with more than 30 years of active development. As major PostgreSQL releases regularly add new features, the layout of the system tables may change. However, the internal data storage format itself rarely changes. This allows you to upgrade a PostgreSQL database system without data loss using the backup and restore functions of the Database API. @@ -28,7 +30,7 @@ In this tutorial, you will learn how to migrate your PostgreSQL databases from v There are three steps to completing a manual migration: creating a new PostgreSQL 13 instance, backing up your existing database using the Scaleway API, and finally restoring your backup on your new PostgreSQL 13 Instance. We walk you through these three steps below. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization @@ -52,7 +54,7 @@ There are three steps to completing a manual migration: creating a new PostgreSQ ### Backing up your existing database using the Scaleway API - + - Generated your [API key](/iam/how-to/create-api-keys/) - Installed `curl` on your local computer @@ -160,7 +162,7 @@ There are three steps to completing a manual migration: creating a new PostgreSQ This solution enables you to migrate your database(s) automatically, with a bash script using the Scaleway CLI v2. The script will walk you through the migration process. - + - A PostgreSQL database running on version 9.6 - Installed the [Scaleway CLI v2](https://github.com/scaleway/scaleway-cli) on your machine and the relevant [PostgreSQL binaries](https://www.postgresql.org/download/) on your machine diff --git a/tutorials/use-cockpit-with-terraform/index.mdx b/tutorials/use-cockpit-with-terraform/index.mdx index 9e381678c7..86b9652954 100644 --- a/tutorials/use-cockpit-with-terraform/index.mdx +++ b/tutorials/use-cockpit-with-terraform/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-02-11 posted: 2024-06-04 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to get started with Cockpit using a Terraform/OpenTofu configuration file containing all the code you need to create: @@ -20,7 +22,7 @@ In this tutorial, you will learn how to get started with Cockpit using a Terrafo - A Cockpit [token](/cockpit/concepts/#cockpit-tokens) with permission to query and push metrics - A metric [data source](/cockpit/concepts/#data-sources) - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/use-container-registry-github-actions/index.mdx b/tutorials/use-container-registry-github-actions/index.mdx index 1b7bd10fe3..c8bce0b738 100644 --- a/tutorials/use-container-registry-github-actions/index.mdx +++ b/tutorials/use-container-registry-github-actions/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-06 posted: 2023-02-27 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial you will learn how to configure and use [GitHub Actions](https://docs.github.com/en/actions) to build a [Docker](https://www.docker.com/) image and push it into [Scaleway Container Registry](https://www.scaleway.com/en/container-registry/). GitHub Actions is a platform for automating software development workflows in the context of GitHub repositories. It allows you to define and run workflows, which are automated sequences of steps that can be triggered by events such as pushes to the repository, pull requests, or the creation of a new tag. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/use-managed-redis-with-mysql/index.mdx b/tutorials/use-managed-redis-with-mysql/index.mdx index 26194e34ef..3994330877 100644 --- a/tutorials/use-managed-redis-with-mysql/index.mdx +++ b/tutorials/use-managed-redis-with-mysql/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2023-11-25 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial demonstrates the integration of a [Scaleway Redis™](https://www.scaleway.com/en/managed-database-for-redistm/) Instance as a record cache (commonly referred to as a second-level cache) for an application using a [Scaleway MySQL](https://www.scaleway.com/fr/database/) Instance through [Entity Framework](https://learn.microsoft.com/en-us/ef/). @@ -19,7 +21,7 @@ This tutorial demonstrates the integration of a [Scaleway Redis™](https://www. While the principles discussed apply to various technologies and data stores, the examples and demonstrations on this page specifically use MySQL as the database, Redis as the cache, and Entity Framework for .NET as the Object-Relational Mapping (ORM) tool. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/using-bucket-website-with-mkdocs/index.mdx b/tutorials/using-bucket-website-with-mkdocs/index.mdx index c281cb5426..fea95e0e15 100644 --- a/tutorials/using-bucket-website-with-mkdocs/index.mdx +++ b/tutorials/using-bucket-website-with-mkdocs/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-04-22 posted: 2024-10-07 --- +import Requirements from '@macros/iam/requirements.mdx' + This tutorial shows you how to create a documentation website using the Scaleway [Object Storage bucket website](/object-storage/concepts/#bucket-website) feature with MkDocs. @@ -20,7 +22,7 @@ We will use MkDocs to generate our website, and Material for MkDocs which is a d You will learn to set up MkDocs and configure, preview, and deploy your website. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/using-own-grafana/index.mdx b/tutorials/using-own-grafana/index.mdx index 92bb944ec9..0f8b4c42e8 100644 --- a/tutorials/using-own-grafana/index.mdx +++ b/tutorials/using-own-grafana/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-01-02 posted: 2023-05-10 --- +import Requirements from '@macros/iam/requirements.mdx' + In this tutorial, you will learn how to use your own Grafana with [Scaleway's Cockpit](/cockpit/quickstart/) service. In this tutorial, we are using Grafana version 9.5.1. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/using-secret-manager-with-github-action/index.mdx b/tutorials/using-secret-manager-with-github-action/index.mdx index 0824888af9..5968572afd 100644 --- a/tutorials/using-secret-manager-with-github-action/index.mdx +++ b/tutorials/using-secret-manager-with-github-action/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-01-02 posted: 2023-06-01 --- +import Requirements from '@macros/iam/requirements.mdx' + GitHub Actions makes it easy to automate all your software workflows, now with world-class CI/CD. Build, test, and deploy your code right from GitHub. Make code reviews, branch management, and issue triaging work the way you want. @@ -21,7 +23,7 @@ Oftentimes, when doing Continuous Integration/Continuous Deployment, you need to A good practice is to use a [Secret Manager](/secret-manager/quickstart/) to store your secrets, securely in one place. When doing that, you have to copy and paste your secrets and put them in your CI which duplicates the secrets and leads to desynchronization with your source of truth. This is where GitHub action is useful. - + - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - A valid [API key](/iam/how-to/create-api-keys/) diff --git a/tutorials/vaultwarden-serverless/index.mdx b/tutorials/vaultwarden-serverless/index.mdx index de107dd6a8..d610bed9c7 100644 --- a/tutorials/vaultwarden-serverless/index.mdx +++ b/tutorials/vaultwarden-serverless/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-04-03 posted: 2025-04-03 --- +import Requirements from '@macros/iam/requirements.mdx' + Vaultwarden is an open-source password manager that helps you securely store and manage your passwords. It is a community-maintained fork of the popular Bitwarden project, offering the same features with flexibility and privacy in mind. @@ -22,7 +24,7 @@ Scaleway Serverless Containers and Serverless SQL Databases allow you to quickly - requires little-to-no maintenance - has built-in resiliency - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/veeam-backup-replication-s3/index.mdx b/tutorials/veeam-backup-replication-s3/index.mdx index 54f7a802f7..c8c1106189 100644 --- a/tutorials/veeam-backup-replication-s3/index.mdx +++ b/tutorials/veeam-backup-replication-s3/index.mdx @@ -11,6 +11,8 @@ tags: vSphere Object-Storage Veeam-Backup Veeam dates: validation: 2025-06-09 --- +import Requirements from '@macros/iam/requirements.mdx' + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/vpc-public-gateway-autoconfiguration/index.mdx b/tutorials/vpc-public-gateway-autoconfiguration/index.mdx index 1a1a476285..cdecd1651d 100644 --- a/tutorials/vpc-public-gateway-autoconfiguration/index.mdx +++ b/tutorials/vpc-public-gateway-autoconfiguration/index.mdx @@ -12,12 +12,15 @@ tags: Private-Network instances Public-Gateway dates: validation: 2025-05-14 --- +import Requirements from '@macros/iam/requirements.mdx' +import NetworkPublicGateways from '@macros/network/public-gateways.mdx' + ## Private Networks and Public Gateways - Overview - + - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/vuls-security-scanner/index.mdx b/tutorials/vuls-security-scanner/index.mdx index 8ecc0a261b..9c3e10f78b 100644 --- a/tutorials/vuls-security-scanner/index.mdx +++ b/tutorials/vuls-security-scanner/index.mdx @@ -12,10 +12,12 @@ dates: validation: 2025-05-19 posted: 2019-03-19 --- +import Requirements from '@macros/iam/requirements.mdx' + [Vuls](https://vuls.io/) is an open-source vulnerability scanner written in [Go](https://go.dev/). It automates security vulnerability checks on the software installed on a system, which can be a demanding task in a system administrator's daily life. Vuls comes with an agent-less architecture, meaning that it uses SSH to scan other hosts and provides three scan modes that can be chosen according to the actual situation (`fast`, `fast root`, and `deep`). The tool can scan multiple systems simultaneously and provide notifications and reports either via Slack or by email. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/waypoint-plugin-scaleway/index.mdx b/tutorials/waypoint-plugin-scaleway/index.mdx index 438597cc8d..dba5b4f2a2 100644 --- a/tutorials/waypoint-plugin-scaleway/index.mdx +++ b/tutorials/waypoint-plugin-scaleway/index.mdx @@ -14,6 +14,8 @@ dates: validation: 2025-01-06 posted: 2023-06-15 --- +import Requirements from '@macros/iam/requirements.mdx' + Waypoint is an open source tool developed by HashiCorp that focuses on simplifying the deployment and release workflows for applications. @@ -69,7 +71,7 @@ A list of all options can be found in [container plugin documentation](https://g ### Usage example - + - A Scaleway account logged into the [console](https://console.scaleway.com) - Installed [Docker](https://www.docker.com/) diff --git a/tutorials/web-deploy-windows-instance/index.mdx b/tutorials/web-deploy-windows-instance/index.mdx index 1f4b01dc76..6b4e7d825e 100644 --- a/tutorials/web-deploy-windows-instance/index.mdx +++ b/tutorials/web-deploy-windows-instance/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-20 posted: 2025-01-20 --- +import Requirements from '@macros/iam/requirements.mdx' + ## How to use Web Deploy to publish a website to Scaleway's Windows Server VMs @@ -25,7 +27,7 @@ Throughout this guide, you will learn how to: - Set up a website in IIS; - Publish an application directly from Visual Studio. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization - An [Instance](/instances/how-to/create-an-instance/) running Windows Server or Windows Server Core diff --git a/tutorials/wireguard-mesh-vpn/index.mdx b/tutorials/wireguard-mesh-vpn/index.mdx index 1443ae0724..3c83ada648 100644 --- a/tutorials/wireguard-mesh-vpn/index.mdx +++ b/tutorials/wireguard-mesh-vpn/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-01-22 posted: 2020-07-02 --- +import Requirements from '@macros/iam/requirements.mdx' + WireGuard is a modern VPN (Virtual Private Network) software. It is designed to be cross-platform and run almost anywhere. Compared to other similar software, it is faster, more secure, and simpler. @@ -27,7 +29,7 @@ We use two Ubuntu Instances, one located in the `PAR-1` region, and the other lo - We recommend you follow this tutorial using a [Learning Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/wordpress-instantapp/index.mdx b/tutorials/wordpress-instantapp/index.mdx index e422d104b0..8887570b9b 100644 --- a/tutorials/wordpress-instantapp/index.mdx +++ b/tutorials/wordpress-instantapp/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-07-02 posted: 2015-05-07 --- +import Requirements from '@macros/iam/requirements.mdx' + WordPress is a popular, free, and open-source blogging tool and content management system (CMS) based on PHP and MariaDB. @@ -19,7 +21,7 @@ Using the WordPress application can significantly save you time and effort, as i This guide demonstrates how to quickly deploy a WordPress application in seconds using Scaleway's InstantApp. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended organizations diff --git a/tutorials/wordpress-lemp-stack-focal/index.mdx b/tutorials/wordpress-lemp-stack-focal/index.mdx index 6963746ec0..3028eced11 100644 --- a/tutorials/wordpress-lemp-stack-focal/index.mdx +++ b/tutorials/wordpress-lemp-stack-focal/index.mdx @@ -12,12 +12,14 @@ dates: validation: 2025-05-19 posted: 2021-12-03 --- +import Requirements from '@macros/iam/requirements.mdx' + WordPress is a popular, free open-source blogging tool and content management system (CMS) based on PHP and MySQL. WordPress has seen incredible adoption rates and is a great choice for getting a website up and running quickly. After setup, almost all the administration can be done through the web frontend. In this tutorial, we will learn how to install WordPress on a freshly created Ubuntu Focal Fossa (20.04 LTS) Instance with LEMP (Linux + Nginx - pronounced "engine x" + MySQL + PHP). Nginx is an HTTP server that, compared to Apache, uses fewer resources and delivers pages much faster, especially static files. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/wordpress-lemp-stack-ubuntu-jammy-jellyfish-22-04/index.mdx b/tutorials/wordpress-lemp-stack-ubuntu-jammy-jellyfish-22-04/index.mdx index 0c89f5f2c9..85c2d7d483 100644 --- a/tutorials/wordpress-lemp-stack-ubuntu-jammy-jellyfish-22-04/index.mdx +++ b/tutorials/wordpress-lemp-stack-ubuntu-jammy-jellyfish-22-04/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-03-19 posted: 2023-02-24 --- +import Requirements from '@macros/iam/requirements.mdx' + WordPress is a popular and freely accessible open-source tool that offers a seamless means to craft and manage content on your website. With its intuitive interface and user-friendly features, WordPress has garnered extensive adoption, making it an ideal solution for swiftly launching a website. The web front-end it provides ensures effortless administration, simplifying the process even for those lacking technical expertise. @@ -21,7 +23,7 @@ If you are seeking to install WordPress on a newly established Ubuntu 22.04 LTS We recommend you follow this tutorial using a [Cost-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/wordpress-lemp-stack/index.mdx b/tutorials/wordpress-lemp-stack/index.mdx index c949801dfb..dd78464493 100644 --- a/tutorials/wordpress-lemp-stack/index.mdx +++ b/tutorials/wordpress-lemp-stack/index.mdx @@ -13,12 +13,14 @@ dates: validation: 2025-05-13 posted: 2018-11-09 --- +import Requirements from '@macros/iam/requirements.mdx' + WordPress is a popular, free open-source blogging tool and content management system (CMS) based on PHP and MySQL. WordPress has seen incredible adoption rates and is a great choice for getting a website up and running quickly. After setup, almost all the administration can be done through the web frontend. In this tutorial, you will learn how to install WordPress on a freshly created Ubuntu Bionic Beaver Instance with LEMP (Linux + Nginx - pronounced "engine x" + MySQL + PHP). Nginx is an HTTP server that, compared to Apache, uses fewer resources and delivers pages much faster, especially static files. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/zabbix-monitoring/index.mdx b/tutorials/zabbix-monitoring/index.mdx index 418ca89390..c4146c130a 100644 --- a/tutorials/zabbix-monitoring/index.mdx +++ b/tutorials/zabbix-monitoring/index.mdx @@ -12,6 +12,8 @@ dates: validation: 2025-05-19 posted: 2019-06-17 --- +import Requirements from '@macros/iam/requirements.mdx' + Zabbix is a powerful open-source software that offers real-time monitoring for servers, virtual machines, network devices, and web applications. Monitoring metrics such as network utilization, CPU load, and disk space consumption are collected by Zabbix and then stored in a database. @@ -23,7 +25,7 @@ In this tutorial, we will use two Scaleway [Production-Optimized](/instances/ref We recommend you follow this tutorial using a [Production-Optimized Instance](/instances/reference-content/choosing-instance-type/). - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/zammad-ticketing/index.mdx b/tutorials/zammad-ticketing/index.mdx index 389ea3cb28..864f9a1fd5 100644 --- a/tutorials/zammad-ticketing/index.mdx +++ b/tutorials/zammad-ticketing/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-19 posted: 2020-12-22 --- +import Requirements from '@macros/iam/requirements.mdx' + Zammad is an open-source helpdesk system that allows you to oversee customer interactions across various communication channels, encompassing telephone, Facebook, Twitter, chat, and emails. Notably, the software is entirely open-source and distributed under the GNU AFFERO General Public License version 3 (GNU AGPLv3). @@ -22,7 +24,7 @@ This tutorial will guide you through the process of installing Zammad on a Scale We recommend you follow this tutorial using a [Cost-Optimized Instance](/instances/reference-content/choosing-instance-type/). If you are installing Zammad on Ubuntu 22.04 and up, avoid using an Instance with ARM architecure to follow this tutorial, as the package manager used upon installation is not compatible with the ARM architecture. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization diff --git a/tutorials/zulip/index.mdx b/tutorials/zulip/index.mdx index fc4562630c..e0b9524819 100644 --- a/tutorials/zulip/index.mdx +++ b/tutorials/zulip/index.mdx @@ -13,6 +13,8 @@ dates: validation: 2025-05-14 posted: 2021-10-21 --- +import Requirements from '@macros/iam/requirements.mdx' + Zulip is an open-source communications platform similar to Mattermost, Slack, or Rocket.Chat, but providing unique features by combining the immediacy of real-time chat with an email threading model. @@ -20,7 +22,7 @@ It aims to make communications in larger groups easier by focusing on important More than 90 integrations are available for Zulip, including GitHub, Jira, Zendesk, and more. Zulip's powerful API allows you to create your own integration as well. - + - A Scaleway account logged into the [console](https://console.scaleway.com) - [Owner](/iam/concepts/#owner) status or [IAM permissions](/iam/concepts/#permission) allowing you to perform actions in the intended Organization