From 6b1651869df48a21b7b390db37907857eceaff4c Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 5 Dec 2024 13:53:44 +0100 Subject: [PATCH 1/3] chore(gen): documentation review MTA-5329 --- .../account/how-to/log-in-to-the-console.mdx | 2 +- .../protecting-yourself-fraud-phishing.mdx | 2 +- .../console-keyboard-shortcuts.mdx | 6 +++- .../object/how-to/create-bucket-policy.mdx | 2 +- tutorials/dhclient-dedibox/index.mdx | 4 ++- .../veeam-backup-replication-s3/index.mdx | 29 +++++++++---------- 6 files changed, 25 insertions(+), 20 deletions(-) diff --git a/console/account/how-to/log-in-to-the-console.mdx b/console/account/how-to/log-in-to-the-console.mdx index be44d4e515..9c1b15e373 100644 --- a/console/account/how-to/log-in-to-the-console.mdx +++ b/console/account/how-to/log-in-to-the-console.mdx @@ -7,7 +7,7 @@ content: paragraph: Steps to log in to the Scaleway console. tags: account login password access magic-link magic link SSO dates: - validation: 2024-05-30 + validation: 2024-12-05 posted: 2024-06-11 categories: - console diff --git a/console/account/troubleshooting/protecting-yourself-fraud-phishing.mdx b/console/account/troubleshooting/protecting-yourself-fraud-phishing.mdx index 99a1e1a97d..3eca5585e9 100644 --- a/console/account/troubleshooting/protecting-yourself-fraud-phishing.mdx +++ b/console/account/troubleshooting/protecting-yourself-fraud-phishing.mdx @@ -7,7 +7,7 @@ content: paragraph: Protect yourself from fraud and phishing in Scaleway. tags: login unrecognized-ip phising fraud dates: - validation: 2024-05-22 + validation: 2024-12-05 posted: 2024-05-22 categories: - console diff --git a/developer-tools/scaleway-cli/reference-content/console-keyboard-shortcuts.mdx b/developer-tools/scaleway-cli/reference-content/console-keyboard-shortcuts.mdx index dd1b4b1577..c77adeb07c 100644 --- a/developer-tools/scaleway-cli/reference-content/console-keyboard-shortcuts.mdx +++ b/developer-tools/scaleway-cli/reference-content/console-keyboard-shortcuts.mdx @@ -13,7 +13,11 @@ categories: - devtools --- -Below is a list of keyboard shortcuts to help you easily use and navigate the Scaleway console CLI: +Below is a list of keyboard shortcuts to help you easily use and navigate the Command Line Interface integrated in the Scaleway console. + + +These shortcuts only apply to the CLI integrated in the [Scaleway console](https://console.scaleway.com). Other CLI tools may have different shortcuts. + |Keys | Action | |-----------------|------------------------------------------------------------| diff --git a/storage/object/how-to/create-bucket-policy.mdx b/storage/object/how-to/create-bucket-policy.mdx index 99658d2e37..00193bbc38 100644 --- a/storage/object/how-to/create-bucket-policy.mdx +++ b/storage/object/how-to/create-bucket-policy.mdx @@ -7,7 +7,7 @@ content: paragraph: Create and apply bucket policies for Object Storage. tags: bucket policy bucket console object storage aws-s3 access dates: - validation: 2024-05-30 + validation: 2024-11-05 posted: 2024-05-30 categories: - storage diff --git a/tutorials/dhclient-dedibox/index.mdx b/tutorials/dhclient-dedibox/index.mdx index f0c74529e5..58254b6d91 100644 --- a/tutorials/dhclient-dedibox/index.mdx +++ b/tutorials/dhclient-dedibox/index.mdx @@ -7,7 +7,7 @@ content: paragraph: This page explains how to configure dhclient as the DHCPv6 client. tags: dhcpv6 duid autostart dhcp dhclient dates: - validation: 2024-05-20 + validation: 2024-12-05 posted: 2021-08-03 categories: - dedibox @@ -15,6 +15,8 @@ categories: 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. + + To install DHCPCD on a Dedibox dedicated server, refer to the [dedicated documentation](/tutorials/dhcpcd-dedibox/). diff --git a/tutorials/veeam-backup-replication-s3/index.mdx b/tutorials/veeam-backup-replication-s3/index.mdx index 31ac4ddfea..397b50220d 100644 --- a/tutorials/veeam-backup-replication-s3/index.mdx +++ b/tutorials/veeam-backup-replication-s3/index.mdx @@ -9,7 +9,7 @@ categories: - object-storage tags: vSphere Object-Storage Veeam-Backup Veeam dates: - validation: 2024-05-20 + validation: 2024-12-05 --- ## Veeam Overview @@ -42,21 +42,19 @@ The following schema represents the functionality of Veeam Backup and Restore wh By default, Veeam manages data in small objects of 1 MB/object. For optimal performance and storage of your backups, the configuration of **Local Target (Large Blocks)** in the storage options of Veeam is recommended. This setting allows you to store your backups in objects of 4MB/object: - - We are currently working on a new backend (available in private beta), which will remove this limitation. ## Configuring Veeam backup & replication - A Veeam **Enterprise** or **Enterprise Plus** license is required to configure the Scale out Repository feature which is required for Object Storage. Contact your Veeam Account Manager in case you need a license upgrade. [More information on Veeam Backup & Replication licensing.](https://www.veeam.com/products-edition-comparison.html) + You must have a Veeam **Enterprise** or **Enterprise Plus** license to configure the Scale out Repository feature, which is required for Object Storage. Contact your Veeam Account Manager in case you need a license upgrade. More information on [Veeam Backup & Replication licensing](https://www.veeam.com/products-edition-comparison.html). ### Configuring an Object Storage repository -1. Once the Veeam Application is installed on your intermediate backup machine, start the Veeam Console by double-clicking on the corresponding icon: +1. Once the Veeam Application is installed on your intermediate Instance, start the Veeam Console by double-clicking on the corresponding icon: -2. Enter the appropriate credits (normally these values are pre-filled) and click **Connect**: +2. Enter the appropriate credentials, and click **Connect**: 3. Once logged into the Veeam console, click **Backup Infrastructure**: @@ -72,17 +70,18 @@ The following schema represents the functionality of Veeam Backup and Restore wh 9. Click **Add** (1) to enter the [API key](/identity-and-access-management/iam/how-to/create-api-keys/) (2) related to the bucket. Optionally a description can be provided: -10. Provide the **Service Point** and the **Region** of your bucket, before clicking on **Next**: +10. Provide the **Service Point** ([regional endpoint](/storage/objects/concepts/#endpoint)), and the **Region** of your bucket, then click **Next**: For a bucket located in the Amsterdam region, the service point is `s3.nl-ams.scw.cloud` and the region is `nl-ams`. -11. Veeam will connect to the Object Storage infrastructure and download the list of buckets. Choose the bucket to be used with Veeam from the drop-down list, click **Browse**, and create and select the folder for storing backups. Then click **Next**: +11. Veeam will connect to the Object Storage infrastructure and download the list of buckets. Choose the bucket to be used with Veeam from the drop-down list. +12. Click **Browse**, create and select the folder for storing backups, then click **Next**: -12. Verify all settings in the summary before clicking on **Finish**: +13. Verify all settings in the summary before clicking on **Finish**: ### Configuring a local backup repository @@ -93,9 +92,9 @@ The following schema represents the functionality of Veeam Backup and Restore wh 3. Click **Microsoft Windows**: -4. Enter a **Name** and an optional **Description** for the repository before clicking on **Next**: +4. Enter a **Name** and an optional **Description** for the repository, then click **Next**: -5. The local machine is pre-configured in this step. Click **Next**: +5. The local machine is pre-configured in this step, then click **Next**: 6. Click **Browse** to select a folder for local backups, then click **Next**: @@ -118,7 +117,7 @@ The following schema represents the functionality of Veeam Backup and Restore wh 5. Click **Extend Scale-out capacity with Object Storage** and choose your Object Storage repository from the drop-down list. It is also possible to define a time frame in which backups are uploaded to Object Storage and after how many days backups are transferred automatically. If required data can also be encrypted by activating the option. Once the Object Storage settings are configured, click **Apply**: -6. Once the scale-out bucket is configured, exit the wizard by clicking on **Finish**. +6. Once the scale-out bucket is configured, exit the wizard by clicking **Finish**. ### Adding a vSphere hypervisor in Veeam @@ -139,17 +138,17 @@ The following schema represents the functionality of Veeam Backup and Restore wh ### Configuring a backup job -1. On the Homepage of the Veeam console, click **New Backup**, then on **Virtual Machine** in the drop-down menu: +1. On the Homepage of the Veeam console, click **New Backup**, then **Virtual Machine** in the drop-down menu: -2. Enter a **Name** and an optional **Description** for the backup job. Then click **Next**: +2. Enter a **Name** and an optional **Description** for the backup job, then click **Next**: 3. Click **Add** (1) and choose the virtual machines or hypervisors (2) to be backed up. Once finished, click **Next**: 4. Choose the previously configured Scale-out repository from the drop-down menu and choose the restore points to keep on disk for the backup. Click **Next** once this is done: -5. Configure guest OS processing options for virtual machines. The default settings should be fine. Validate it by clicking on **Next**: +5. Configure guest OS processing options for virtual machines(the default settings are usually sufficient), then click **Next**: 6. Configure a schedule to execute the backup job automatically. If no schedule is configured, the job must be started manually for each backup. Once the schedule is set, click **Next**: From 65cc2ede66c7bf48701511eda0d3540a2a333428 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Thu, 5 Dec 2024 14:06:04 +0100 Subject: [PATCH 2/3] chore(gen): update --- tutorials/cloud-controller-manager/index.mdx | 197 ------------------- 1 file changed, 197 deletions(-) delete mode 100644 tutorials/cloud-controller-manager/index.mdx diff --git a/tutorials/cloud-controller-manager/index.mdx b/tutorials/cloud-controller-manager/index.mdx deleted file mode 100644 index 63db9e9863..0000000000 --- a/tutorials/cloud-controller-manager/index.mdx +++ /dev/null @@ -1,197 +0,0 @@ ---- -meta: - title: Getting started with the Cloud Controller Manager - description: This page explains how to create a Kubernetes cluster with kubeadm and cloud-controller-manager -content: - h1: Getting started with the Cloud Controller Manager - paragraph: This page explains how to create a Kubernetes cluster with kubeadm and cloud-controller-manager -categories: - - instances - - kubernetes -tags: kubeadm cloud-controller-manager -dates: - validation: 2024-05-20 - posted: 2020-03-19 ---- - -A Cloud Controller Manager is a daemon that embeds cloud-specific control loops. It can be used to deploy resources in the Scaleway ecosystem. - -Currently, the `scaleway-cloud-controller-manager` implements: - -- **Instances interface**: updates nodes with cloud provider-specific labels and addresses, also deletes Kubernetes nodes when deleted from the cloud provider. -- **LoadBalancer interface**: responsible for creating load balancers when a service of type: `LoadBalancer` is created in Kubernetes. -- **Zone interface**: makes Kubernetes aware of the failure domain of each node. - -The Scaleway Cloud Controller Manager is currently under active development and released as an open-source project on [GitHub](https://github.com/scaleway/scaleway-cloud-controller-manager). - - - -- A Scaleway account logged into the [console](https://console.scaleway.com) -- [Owner](/identity-and-access-management/iam/concepts/#owner) status or [IAM permissions](/identity-and-access-management/iam/concepts/#permission) allowing you to perform actions in the intended Organization -- An [SSH key](/identity-and-access-management/organizations-and-projects/how-to/create-ssh-key/) -- A valid [API key](/identity-and-access-management/iam/how-to/create-api-keys/) -- 3 [Instances](/compute/instances/how-to/create-an-instance/) running Ubuntu Bionic - -## Creating a Kubernetes cluster using kubeadm on Scaleway - -The goal of this step is to create a `Kubernetes` cluster using `kubeadm` on Scaleway [Instances](https://www.scaleway.com/en/virtual-instances/). - -To follow this example, you need to create three Ubuntu Bionic Instances: -- `main1` -- `node1` -- `node2` - -1. Run the following commands on each of your Instances: - ```bash - apt-get update && apt-get install -y \ - iptables \ - arptables \ - ebtables \ - apt-transport-https \ - ca-certificates \ - curl \ - gnupg-agent \ - software-properties-common - curl -s https://packages.cloud.google.com/apt/doc/apt-key.gpg | apt-key add - - add-apt-repository \ - "deb [arch=amd64] https://apt.kubernetes.io kubernetes-xenial main" - curl -fsSL https://download.docker.com/linux/ubuntu/gpg | apt-key add - - add-apt-repository \ - "deb [arch=amd64] https://download.docker.com/linux/ubuntu \ - $(lsb_release -cs) \ - stable" - apt-get update && apt-get install -y \ - docker-ce docker-ce-cli containerd.io kubelet kubeadm kubectl - apt-mark hold \ - docker-ce docker-ce-cli containerd.io kubelet kubeadm kubectl - echo KUBELET_EXTRA_ARGS=\"--cloud-provider=external\" > /etc/default/kubelet - ``` -2. Initialize the Kubernetes main on the Instance `main1`: - ```bash - root@main1:~# kubeadm init --control-plane-endpoint=$(scw-metadata PUBLIC_IP_ADDRESS) --apiserver-cert-extra-sans=$(scw-metadata PUBLIC_IP_ADDRESS) - root@main1:~# mkdir -p ~/.kube - root@main1:~# cp -i /etc/kubernetes/admin.conf $HOME/.kube/config - root@main1:~# chown $(id -u):$(id -g) $HOME/.kube/config - root@main1:~# kubectl apply -f https://docs.projectcalico.org/v3.11/manifests/calico.yaml - ``` -3. During the installation the `kubeadm join` command displays. Note it down as it is required for the worker nodes to join the cluster. You can also copy the `kubeconfig` file and save it on your local computer. -4. Execute the `kubeadm join` command on the worker node to join the cluster: - ```bash - root@node1:~# kubeadm join 10.68.34.145:6443 --token itvo0b.kwoao79ptlj22gno \ - --discovery-token-ca-cert-hash sha256:07bc3f9601f1659771a7a6fd696c2969cbc757b088ec752ba95d5a42c06ed91f - ``` -5. Verify the status of the cluster on the main by running the `kubectl get nodes` command. - ```bash - root@main1:~# kubectl get nodes - NAME STATUS ROLES AGE VERSION - main1 Ready main 18m v1.17.4 - node1 Ready 8m38s v1.17.4 - node2 Ready 2m31s v1.17.4 - ``` - - The cluster is ready and working. Continue by deploying the `cloud-controller-manager`. - -## Deploying the cloud-controller-manager on the cluster - -To deploy the `cloud-controller-manager` the following information is required: - -- Your access key. -- Your secret key. -- Your organization id. -- The Scaleway region. - - - You can find this information in the [Scaleway console](https://console.scaleway.com/account/credential). - - -1. Create a `k8s-scaleway-secret.yml` file containing the following information: - ```bash - root@master1:~# nano k8s-scaleway-secret.yml - ``` - - ```bash - root@main1:~# nano k8s-scaleway-secret.yml - ``` - - ```yaml - apiVersion: v1 - kind: Secret - metadata: - name: scaleway-secret - namespace: kube-system - stringData: - SCW_ACCESS_KEY: 'xxxxxxxxxxxxxxxx' - SCW_SECRET_KEY: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' - SCW_DEFAULT_REGION: 'fr-par' - SCW_DEFAULT_ORGANIZATION_ID: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxx' - ``` -2. Create the `secret` and deploy the controller - ```bash - root@main1:~# kubectl create -f k8s-scaleway-secret.yml - root@main1:~# kubectl apply -f https://raw.githubusercontent.com/scaleway/scaleway-cloud-controller-manager/main/examples/k8s-scaleway-ccm-latest.yml - ``` - -## Checking that the cloud-controller-manager is working - -1. Verify the `cloud-controller-manager` is running from the `main1` instance: - ```bash - root@main1:~# kubectl get pods -n kube-system -l app=scaleway-cloud-controller-manager - NAME READY STATUS RESTARTS AGE - scaleway-cloud-controller-manager-584558b994-rln4j 1/1 Running 0 12s - root@main1:~# kubectl get nodes - NAME STATUS ROLES AGE VERSION - main1 Ready main 18m v1.17.4 - node1 Ready 8m38s v1.17.4 - node2 Ready 2m31s v1.17.4 - ``` -2. Deploy a `LoadBalancer` service and make sure a public IP is assigned to this service. The service will automatically create a [managed Load Balancer](https://www.scaleway.com/en/load-balancer/) on the Scaleway platform. - Create a `lb.yml` file that contains the following information: - - ```bash - root@main1:~# nano lb.yml - ``` - - ```yaml - apiVersion: v1 - kind: Service - metadata: - name: example-service - spec: - selector: - app: example - ports: - - port: 8765 - targetPort: 9376 - type: LoadBalancer - ``` - - ```yaml - apiVersion: v1 - kind: Service - metadata: - name: example-service - spec: - selector: - app: example - ports: - - port: 8765 - targetPort: 9376 - type: LoadBalancer - ``` -3. Create the service from the configuration file: - ```bash - root@main1:~# kubectl create -f lb.yml - ``` -4. Verify if the service has been created: - ```bash - root@main1:~# kubectl get services - NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE - example-service LoadBalancer 10.106.144.144 51.159.26.121 8765:30175/TCP 7s - kubernetes ClusterIP 10.96.0.1 443/TCP 21m - ``` - -The `LoadBalancer` service with the internal IP `10.106.144.144` and external IP `51.159.26.121` has been created. - -You have successfully deployed a cluster with `kubeadm` and the `scaleway-cloud-controlle-manager`. -To learn more about the function of a Cloud Controller Manager within Kubernetes, refer to the [official documentation](https://kubernetes.io/docs/tasks/administer-cluster/running-cloud-controller/). -For more information about the Scaleway Cloud Controller Manager, follow the project on [GitHub](https://github.com/scaleway/scaleway-cloud-controller-manager). \ No newline at end of file From 3a8d0132b73cd6c25dbabf6567f5327f5cca95a2 Mon Sep 17 00:00:00 2001 From: SamyOubouaziz Date: Mon, 9 Dec 2024 10:21:50 +0100 Subject: [PATCH 3/3] Update tutorials/veeam-backup-replication-s3/index.mdx Co-authored-by: nerda-codes <87707325+nerda-codes@users.noreply.github.com> --- tutorials/veeam-backup-replication-s3/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tutorials/veeam-backup-replication-s3/index.mdx b/tutorials/veeam-backup-replication-s3/index.mdx index 397b50220d..11bd7cba28 100644 --- a/tutorials/veeam-backup-replication-s3/index.mdx +++ b/tutorials/veeam-backup-replication-s3/index.mdx @@ -148,7 +148,7 @@ The following schema represents the functionality of Veeam Backup and Restore wh 4. Choose the previously configured Scale-out repository from the drop-down menu and choose the restore points to keep on disk for the backup. Click **Next** once this is done: -5. Configure guest OS processing options for virtual machines(the default settings are usually sufficient), then click **Next**: +5. Configure guest OS processing options for virtual machines (the default settings are usually sufficient), then click **Next**: 6. Configure a schedule to execute the backup job automatically. If no schedule is configured, the job must be started manually for each backup. Once the schedule is set, click **Next**: